Skip to content

Commit e91cdfd

Browse files
gierschvgierschv
committed
feat(client): Update to API specification v2.2
1 parent 6e8f8c2 commit e91cdfd

File tree

148 files changed

+19330
-2995
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+19330
-2995
lines changed

‎.swagger-codegen-ignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Swagger Codegen Ignore
2-
README.md
32
.gitignore
43
.travis.yml
54
git_push.sh
5+
package.json

‎.swagger-codegen/VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.2.3-SNAPSHOT

‎CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# Changelog
22

3+
## 0.3.0
4+
5+
* feat(edu): Public release of the first education APIs:
6+
* `/v2/classes`: Classes management
7+
* `/v2/classes/{class}/assignments`: Flat Assignments and Submissions
8+
* `/v2/organizations/users`: Organization accounts management
9+
* `/v2/organizations/invitations`: Organization invitations for admins and teachers
10+
* `/v2/organizations/lti/credentials`: LTI credentials management
11+
* `/v2/groups/{group}` and `/groups/{group}/users`: List of groups and users part of groups
12+
* `/scores/{score}/submissions`: Submissions linked to a score
13+
* feat(edu): New OAuth2 scopes:
14+
* `edu.classes`: Full, permissive scope to manage the classes.
15+
* `edu.classes.readonly`: Read-only access to the classes.
16+
* `edu.assignments`: Read-write access to the assignments and submissions.
17+
* `edu.assignments.readonly`: Read-only access to the assignments and submissions.
18+
* `edu.admin`: Full, permissive scope to manage all the admin of an organization.
19+
* `edu.admin.lti`: Access and manage the LTI Credentials for an organization.
20+
* `edu.admin.lti.readonly`: Read-only access to the LTI Credentials of an organization.
21+
* `edu.admin.users`: Access and manage the users and invitations of the organization.
22+
* `edu.admin.users.readonly`: Read-only access to the users and invitations of the organization.
23+
* fix(spec): Add missing scopes in specification for `GET /scores/{score}/revisions/{revision}` and `GET /scores/{score}/revisions/{revision}/{format}`
24+
325
## 0.2.0
426

527
* feat(scores): add support of private links sharing with `sharingKey`.

‎README.md

Lines changed: 76 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,35 @@ All URIs are relative to *https://api.flat.io/v2*
8383
Class | Method | HTTP request | Description
8484
------------ | ------------- | ------------- | -------------
8585
*FlatApi.AccountApi* | [**getAuthenticatedUser**](docs/AccountApi.md#getAuthenticatedUser) | **GET** /me | Get current user profile
86+
*FlatApi.ClassApi* | [**addClassUser**](docs/ClassApi.md#addClassUser) | **PUT** /classes/{class}/users/{user} | Add a user to the class
87+
*FlatApi.ClassApi* | [**archiveClass**](docs/ClassApi.md#archiveClass) | **POST** /classes/{class}/archive | Archive the class
88+
*FlatApi.ClassApi* | [**copyAssignment**](docs/ClassApi.md#copyAssignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment
89+
*FlatApi.ClassApi* | [**createAssignment**](docs/ClassApi.md#createAssignment) | **POST** /classes/{class}/assignments | Assignment creation
90+
*FlatApi.ClassApi* | [**createClass**](docs/ClassApi.md#createClass) | **POST** /classes | Create a new class
91+
*FlatApi.ClassApi* | [**createSubmission**](docs/ClassApi.md#createSubmission) | **PUT** /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission
92+
*FlatApi.ClassApi* | [**deleteClassUser**](docs/ClassApi.md#deleteClassUser) | **DELETE** /classes/{class}/users/{user} | Remove a user from the class
93+
*FlatApi.ClassApi* | [**editSubmission**](docs/ClassApi.md#editSubmission) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission
94+
*FlatApi.ClassApi* | [**enrollClass**](docs/ClassApi.md#enrollClass) | **POST** /classes/enroll/{enrollmentCode} | Join a class
95+
*FlatApi.ClassApi* | [**getClass**](docs/ClassApi.md#getClass) | **GET** /classes/{class} | Get the details of a single class
96+
*FlatApi.ClassApi* | [**getScoreSubmissions**](docs/ClassApi.md#getScoreSubmissions) | **GET** /scores/{score}/submissions | List submissions related to the score
97+
*FlatApi.ClassApi* | [**getSubmission**](docs/ClassApi.md#getSubmission) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission
98+
*FlatApi.ClassApi* | [**getSubmissions**](docs/ClassApi.md#getSubmissions) | **GET** /classes/{class}/assignments/{assignment}/submissions | List the students' submissions
99+
*FlatApi.ClassApi* | [**listAssignments**](docs/ClassApi.md#listAssignments) | **GET** /classes/{class}/assignments | Assignments listing
100+
*FlatApi.ClassApi* | [**listClassStudentSubmissions**](docs/ClassApi.md#listClassStudentSubmissions) | **GET** /classes/{class}/students/{user}/submissions | List the submissions for a student
101+
*FlatApi.ClassApi* | [**listClasses**](docs/ClassApi.md#listClasses) | **GET** /classes | List the classes available for the current user
102+
*FlatApi.ClassApi* | [**unarchiveClass**](docs/ClassApi.md#unarchiveClass) | **DELETE** /classes/{class}/archive | Unarchive the class
103+
*FlatApi.ClassApi* | [**updateClass**](docs/ClassApi.md#updateClass) | **PUT** /classes/{class} | Update the class
104+
*FlatApi.GroupApi* | [**getGroupDetails**](docs/GroupApi.md#getGroupDetails) | **GET** /groups/{group} | Get group information
86105
*FlatApi.GroupApi* | [**getGroupScores**](docs/GroupApi.md#getGroupScores) | **GET** /groups/{group}/scores | List group's scores
106+
*FlatApi.GroupApi* | [**listGroupUsers**](docs/GroupApi.md#listGroupUsers) | **GET** /groups/{group}/users | List group's users
107+
*FlatApi.OrganizationApi* | [**createLtiCredentials**](docs/OrganizationApi.md#createLtiCredentials) | **POST** /organizations/lti/credentials | Create a new couple of LTI 1.x credentials
108+
*FlatApi.OrganizationApi* | [**createOrganizationInvitation**](docs/OrganizationApi.md#createOrganizationInvitation) | **POST** /organizations/invitations | Create a new invitation to join the organization
109+
*FlatApi.OrganizationApi* | [**createOrganizationUser**](docs/OrganizationApi.md#createOrganizationUser) | **POST** /organizations/users | Create a new user account
110+
*FlatApi.OrganizationApi* | [**listLtiCredentials**](docs/OrganizationApi.md#listLtiCredentials) | **GET** /organizations/lti/credentials | List LTI 1.x credentials
111+
*FlatApi.OrganizationApi* | [**listOrganizationInvitations**](docs/OrganizationApi.md#listOrganizationInvitations) | **GET** /organizations/invitations | List the organization invitations
112+
*FlatApi.OrganizationApi* | [**listOrganizationUsers**](docs/OrganizationApi.md#listOrganizationUsers) | **GET** /organizations/users | List the organization users
113+
*FlatApi.OrganizationApi* | [**removeOrganizationInvitation**](docs/OrganizationApi.md#removeOrganizationInvitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation
114+
*FlatApi.OrganizationApi* | [**revokeLtiCredentials**](docs/OrganizationApi.md#revokeLtiCredentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials
87115
*FlatApi.ScoreApi* | [**addScoreCollaborator**](docs/ScoreApi.md#addScoreCollaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator
88116
*FlatApi.ScoreApi* | [**createScore**](docs/ScoreApi.md#createScore) | **POST** /scores | Create a new score
89117
*FlatApi.ScoreApi* | [**createScoreRevision**](docs/ScoreApi.md#createScoreRevision) | **POST** /scores/{score}/revisions | Create a new revision
@@ -100,6 +128,7 @@ Class | Method | HTTP request | Description
100128
*FlatApi.ScoreApi* | [**getScoreRevision**](docs/ScoreApi.md#getScoreRevision) | **GET** /scores/{score}/revisions/{revision} | Get a score revision
101129
*FlatApi.ScoreApi* | [**getScoreRevisionData**](docs/ScoreApi.md#getScoreRevisionData) | **GET** /scores/{score}/revisions/{revision}/{format} | Get a score revision data
102130
*FlatApi.ScoreApi* | [**getScoreRevisions**](docs/ScoreApi.md#getScoreRevisions) | **GET** /scores/{score}/revisions | List the revisions
131+
*FlatApi.ScoreApi* | [**getScoreSubmissions**](docs/ScoreApi.md#getScoreSubmissions) | **GET** /scores/{score}/submissions | List submissions related to the score
103132
*FlatApi.ScoreApi* | [**getUserScores**](docs/ScoreApi.md#getUserScores) | **GET** /users/{user}/scores | List user's scores
104133
*FlatApi.ScoreApi* | [**markScoreCommentResolved**](docs/ScoreApi.md#markScoreCommentResolved) | **PUT** /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved
105134
*FlatApi.ScoreApi* | [**markScoreCommentUnresolved**](docs/ScoreApi.md#markScoreCommentUnresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved
@@ -113,10 +142,38 @@ Class | Method | HTTP request | Description
113142

114143
## Documentation for Models
115144

145+
- [FlatApi.Assignment](docs/Assignment.md)
146+
- [FlatApi.AssignmentCopy](docs/AssignmentCopy.md)
147+
- [FlatApi.AssignmentCreation](docs/AssignmentCreation.md)
148+
- [FlatApi.AssignmentSubmission](docs/AssignmentSubmission.md)
149+
- [FlatApi.AssignmentSubmissionUpdate](docs/AssignmentSubmissionUpdate.md)
150+
- [FlatApi.ClassAttachmentCreation](docs/ClassAttachmentCreation.md)
151+
- [FlatApi.ClassCreation](docs/ClassCreation.md)
152+
- [FlatApi.ClassDetails](docs/ClassDetails.md)
153+
- [FlatApi.ClassDetailsCanvas](docs/ClassDetailsCanvas.md)
154+
- [FlatApi.ClassDetailsGoogleClassroom](docs/ClassDetailsGoogleClassroom.md)
155+
- [FlatApi.ClassDetailsGoogleDrive](docs/ClassDetailsGoogleDrive.md)
156+
- [FlatApi.ClassDetailsLti](docs/ClassDetailsLti.md)
116157
- [FlatApi.ClassRoles](docs/ClassRoles.md)
158+
- [FlatApi.ClassState](docs/ClassState.md)
159+
- [FlatApi.ClassStreamPostMode](docs/ClassStreamPostMode.md)
160+
- [FlatApi.ClassUpdate](docs/ClassUpdate.md)
117161
- [FlatApi.FlatErrorResponse](docs/FlatErrorResponse.md)
118162
- [FlatApi.FlatLocales](docs/FlatLocales.md)
163+
- [FlatApi.GoogleClassroomCoursework](docs/GoogleClassroomCoursework.md)
164+
- [FlatApi.GoogleClassroomSubmission](docs/GoogleClassroomSubmission.md)
119165
- [FlatApi.Group](docs/Group.md)
166+
- [FlatApi.GroupDetails](docs/GroupDetails.md)
167+
- [FlatApi.GroupType](docs/GroupType.md)
168+
- [FlatApi.LicenseMode](docs/LicenseMode.md)
169+
- [FlatApi.LicenseSources](docs/LicenseSources.md)
170+
- [FlatApi.LmsName](docs/LmsName.md)
171+
- [FlatApi.LtiCredentials](docs/LtiCredentials.md)
172+
- [FlatApi.LtiCredentialsCreation](docs/LtiCredentialsCreation.md)
173+
- [FlatApi.MediaAttachment](docs/MediaAttachment.md)
174+
- [FlatApi.MediaScoreSharingMode](docs/MediaScoreSharingMode.md)
175+
- [FlatApi.OrganizationInvitation](docs/OrganizationInvitation.md)
176+
- [FlatApi.OrganizationInvitationCreation](docs/OrganizationInvitationCreation.md)
120177
- [FlatApi.OrganizationRoles](docs/OrganizationRoles.md)
121178
- [FlatApi.ScoreCollaborator](docs/ScoreCollaborator.md)
122179
- [FlatApi.ScoreCollaboratorCreation](docs/ScoreCollaboratorCreation.md)
@@ -128,7 +185,6 @@ Class | Method | HTTP request | Description
128185
- [FlatApi.ScoreCreation](docs/ScoreCreation.md)
129186
- [FlatApi.ScoreData](docs/ScoreData.md)
130187
- [FlatApi.ScoreDataEncoding](docs/ScoreDataEncoding.md)
131-
- [FlatApi.ScoreDetails](docs/ScoreDetails.md)
132188
- [FlatApi.ScoreFork](docs/ScoreFork.md)
133189
- [FlatApi.ScoreLikesCounts](docs/ScoreLikesCounts.md)
134190
- [FlatApi.ScoreModification](docs/ScoreModification.md)
@@ -141,9 +197,17 @@ Class | Method | HTTP request | Description
141197
- [FlatApi.ScoreSummary](docs/ScoreSummary.md)
142198
- [FlatApi.ScoreViewsCounts](docs/ScoreViewsCounts.md)
143199
- [FlatApi.UserBasics](docs/UserBasics.md)
144-
- [FlatApi.UserDetails](docs/UserDetails.md)
145-
- [FlatApi.UserPublic](docs/UserPublic.md)
200+
- [FlatApi.UserCreation](docs/UserCreation.md)
201+
- [FlatApi.UserDetailsAdminLicense](docs/UserDetailsAdminLicense.md)
202+
- [FlatApi.ScoreDetails](docs/ScoreDetails.md)
146203
- [FlatApi.UserPublicSummary](docs/UserPublicSummary.md)
204+
- [FlatApi.UserDetailsAdmin](docs/UserDetailsAdmin.md)
205+
- [FlatApi.UserPublic](docs/UserPublic.md)
206+
- [FlatApi.UserDetails](docs/UserDetails.md)
207+
208+
209+
## Documentation for Authorization
210+
147211

148212
### OAuth2
149213

@@ -156,7 +220,12 @@ Class | Method | HTTP request | Description
156220
- scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores.
157221
- scores.social: Allow to post comments and like scores
158222
- scores: Full, permissive scope to access all of a user's scores.
159-
160-
## Author
161-
162-
Flat - [email protected]
223+
- edu.classes: Full, permissive scope to manage the classes.
224+
- edu.classes.readonly: Read-only access to the classes.
225+
- edu.assignments: Read-write access to the assignments and submissions.
226+
- edu.assignments.readonly: Read-only access to the assignments and submissions.
227+
- edu.admin: Full, permissive scope to manage all the admin of an organization.
228+
- edu.admin.lti: Access and manage the LTI Credentials for an organization.
229+
- edu.admin.lti.readonly: Read-only access to the LTI Credentials of an organization.
230+
- edu.admin.users: Access and manage the users and invitations of the organization.
231+
- edu.admin.users.readonly: Read-only access to the users and invitations of the organization.

0 commit comments

Comments
 (0)