Releases: FlatIO/api-client-js
Releases Β· FlatIO/api-client-js
v0.6.0
- feat(collections): Add new Collections API endpoints
POST /collections
: Create new collectionGET /collections
: List collectionsGET /collections/{collection}
: Get collection detailsPUT /collections/{collection}
: Update collection detailsDELETE /collections/{collection}
: Delete collectionPOST /collections/{collection}/untrash
: Untrash collectionGET /collections/{collection}/scores
: List scores contained in a collectionPUT /collections/{collection}/scores/{score}
: Add a score to a collectionDELETE /collections/{collection}/scores/{score}
: Remove a score from a collection
- feat(collections): Add new OAuth2 scopes for new features:
collections.readonly
: Allow read-only access to a user's collections.collections.add_scores
: Allow to add scores to a user's collections.collections
: Full, permissive scope to access all of a user's collections.
- feat(score): Added new method to untrash a score (
POST /v2/scores/{score}/untrash
) - feat(score):
DELETE /v2/scores/{score}
can now be used without admin rights. This new behavior will unshare the score from the current account. - feat(score):
POST /scores/{score}/fork
now accepts a collection identifier to copy a score to a specific collection. - feat(comments): Comments can now be filtered by type with the new query string
type
(document
orinline
). - update(openapi): Some schema definitions have been renamed, they are now used for Scores and Collections
ScoreRights
->ResourceRights
ScoreCollaborator
->ResourceCollaborator
ScoreCollaboratorCreation
->ResourceCollaboratorCreation
- existing score sharing key ->
ResourceSharingKey
- DEPRECATED:
GET /scores/{score}/revisions/{revision}/{format}
no longer support part indexes for single/set of parts exports, but our own part UUIDs. - DEPRECATED on 2019-01-01:
GET /users/{user}/scores
will no longer list private and shared scores, but only public scores of a Flat account.
API v2.5.0 to v2.5.2
- feat(scores): Add video & audio tracks support for scores:
/v2/scores/{score}/tracks
. - fix(user): Add missing escape in
pattern
(UserCreation.username
). - fix(score): missing ScoreRights.aclRead type
v0.5.0
- feat(scores): New metadata and update of
PUT /v2/scores/{score}
:- Added metadata in API
subtitle
,lyricist
,composer
,description
,tags
,creationType
,license
,licenseText
,durationTime
,numberMeasures
,mainTempoQpm
,publicationDate
. PUT /v2/scores/{score}
: Removetitle
property, this one can be updated by saving a new revision of the score data.PUT /v2/scores/{score}
: New settable properties:description
,tags
,creationType
,license
.
- Added metadata in API
v0.4.0
- feat(user): Add profile theme and instruments played.
- feat(edu): Add new cursor-based pagination for
GET /v2/organizations/users
andGET /v2/organizations/invitations
. - feat(edu): Add new methods:
PUT /v2/organizations/users/{user}
: Admin endpoint to update managed accounts.DELETE /v2/organizations/users/{user}
: Admin endpoint to delete or convert edu accounts to consumer accounts.
- feat(edu): Classes have a new state
inactive
that can be activated using the new methodPOST /v2/classes/{class}/activate
. - feat(edu): Assignments have a new state
draft
and can have a new attachment typeexercise
. - feat(edu): Return Canvas LMS Instance domain in classes details
- feat(edu): Return Clever.com section information in classes details
v0.3.0
- feat(edu): Public release of the first education APIs:
/v2/classes
: Classes management/v2/classes/{class}/assignments
: Flat Assignments and Submissions/v2/organizations/users
: Organization accounts management/v2/organizations/invitations
: Organization invitations for admins and teachers/v2/organizations/lti/credentials
: LTI credentials management/v2/groups/{group}
and/groups/{group}/users
: List of groups and users part of groups/scores/{score}/submissions
: Submissions linked to a score
- feat(edu): New OAuth2 scopes:
edu.classes
: Full, permissive scope to manage the classes.edu.classes.readonly
: Read-only access to the classes.edu.assignments
: Read-write access to the assignments and submissions.edu.assignments.readonly
: Read-only access to the assignments and submissions.edu.admin
: Full, permissive scope to manage all the admin of an organization.edu.admin.lti
: Access and manage the LTI Credentials for an organization.edu.admin.lti.readonly
: Read-only access to the LTI Credentials of an organization.edu.admin.users
: Access and manage the users and invitations of the organization.edu.admin.users.readonly
: Read-only access to the users and invitations of the organization.
- fix(spec): Add missing scopes in specification for
GET /scores/{score}/revisions/{revision}
andGET /scores/{score}/revisions/{revision}/{format}
v0.2.0
- feat(scores): add support of private links sharing with
sharingKey
. - feat(comments): Make "revision" optional when creating comments and support of "last" keyword.
- fix(revisions): Missing
id
property inScoreRevision
. - update(spec): Specify
binary
response type forGET /scores/{score}/revisions/{revision}/{format}