flat_api 0.1.2 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/README.md +34 -12
- data/docs/ClassApi.md +2 -2
- data/docs/Collection.md +18 -0
- data/docs/CollectionApi.md +521 -0
- data/docs/CollectionCapabilities.md +12 -0
- data/docs/CollectionCreation.md +8 -0
- data/docs/CollectionModification.md +8 -0
- data/docs/CollectionPrivacy.md +7 -0
- data/docs/CollectionTitle.md +7 -0
- data/docs/CollectionType.md +7 -0
- data/docs/ResourceCollaborator.md +16 -0
- data/docs/{ScoreCollaboratorCreation.md → ResourceCollaboratorCreation.md} +2 -1
- data/docs/ResourceRights.md +10 -0
- data/docs/ResourceSharingKey.md +7 -0
- data/docs/ScoreApi.md +144 -91
- data/docs/ScoreCreation.md +2 -1
- data/docs/ScoreDetails.md +2 -2
- data/docs/ScoreFork.md +1 -0
- data/docs/ScoreModification.md +2 -1
- data/docs/UserApi.md +1 -1
- data/flat_api.gemspec +1 -1
- data/lib/flat_api.rb +13 -4
- data/lib/flat_api/api/account_api.rb +1 -1
- data/lib/flat_api/api/class_api.rb +1 -1
- data/lib/flat_api/api/collection_api.rb +596 -0
- data/lib/flat_api/api/group_api.rb +1 -1
- data/lib/flat_api/api/organization_api.rb +1 -1
- data/lib/flat_api/api/score_api.rb +125 -53
- data/lib/flat_api/api/user_api.rb +3 -3
- data/lib/flat_api/api_client.rb +1 -1
- data/lib/flat_api/api_error.rb +1 -1
- data/lib/flat_api/configuration.rb +1 -1
- data/lib/flat_api/models/assignment.rb +1 -1
- data/lib/flat_api/models/assignment_copy.rb +1 -1
- data/lib/flat_api/models/assignment_creation.rb +1 -1
- data/lib/flat_api/models/assignment_submission.rb +1 -1
- data/lib/flat_api/models/assignment_submission_update.rb +1 -1
- data/lib/flat_api/models/class_attachment_creation.rb +1 -1
- data/lib/flat_api/models/class_creation.rb +1 -1
- data/lib/flat_api/models/class_details.rb +1 -1
- data/lib/flat_api/models/class_details_canvas.rb +1 -1
- data/lib/flat_api/models/class_details_clever.rb +1 -1
- data/lib/flat_api/models/class_details_google_classroom.rb +1 -1
- data/lib/flat_api/models/class_details_google_drive.rb +1 -1
- data/lib/flat_api/models/class_details_lti.rb +1 -1
- data/lib/flat_api/models/class_roles.rb +1 -1
- data/lib/flat_api/models/class_state.rb +1 -1
- data/lib/flat_api/models/class_update.rb +1 -1
- data/lib/flat_api/models/collection.rb +285 -0
- data/lib/flat_api/models/collection_capabilities.rb +229 -0
- data/lib/flat_api/models/collection_creation.rb +193 -0
- data/lib/flat_api/models/collection_modification.rb +188 -0
- data/lib/flat_api/models/collection_privacy.rb +30 -0
- data/lib/flat_api/models/collection_title.rb +179 -0
- data/lib/flat_api/models/collection_type.rb +34 -0
- data/lib/flat_api/models/flat_error_response.rb +1 -1
- data/lib/flat_api/models/flat_locales.rb +1 -1
- data/lib/flat_api/models/google_classroom_coursework.rb +1 -1
- data/lib/flat_api/models/google_classroom_submission.rb +1 -1
- data/lib/flat_api/models/group.rb +1 -1
- data/lib/flat_api/models/group_details.rb +1 -1
- data/lib/flat_api/models/group_type.rb +1 -1
- data/lib/flat_api/models/license_mode.rb +1 -1
- data/lib/flat_api/models/license_sources.rb +1 -1
- data/lib/flat_api/models/lms_name.rb +1 -1
- data/lib/flat_api/models/lti_credentials.rb +1 -1
- data/lib/flat_api/models/lti_credentials_creation.rb +1 -1
- data/lib/flat_api/models/media_attachment.rb +1 -1
- data/lib/flat_api/models/media_score_sharing_mode.rb +1 -1
- data/lib/flat_api/models/organization_invitation.rb +1 -1
- data/lib/flat_api/models/organization_invitation_creation.rb +1 -1
- data/lib/flat_api/models/organization_roles.rb +1 -1
- data/lib/flat_api/models/{score_collaborator.rb → resource_collaborator.rb} +54 -44
- data/lib/flat_api/models/{score_collaborator_creation.rb → resource_collaborator_creation.rb} +14 -4
- data/lib/flat_api/models/{score_rights.rb → resource_rights.rb} +6 -6
- data/lib/flat_api/models/resource_sharing_key.rb +179 -0
- data/lib/flat_api/models/score_comment.rb +1 -1
- data/lib/flat_api/models/score_comment_context.rb +1 -1
- data/lib/flat_api/models/score_comment_creation.rb +1 -1
- data/lib/flat_api/models/score_comment_update.rb +1 -1
- data/lib/flat_api/models/score_comments_counts.rb +1 -1
- data/lib/flat_api/models/score_creation.rb +13 -3
- data/lib/flat_api/models/score_creation_type.rb +1 -1
- data/lib/flat_api/models/score_data.rb +1 -1
- data/lib/flat_api/models/score_data_encoding.rb +1 -1
- data/lib/flat_api/models/score_details.rb +3 -3
- data/lib/flat_api/models/score_fork.rb +13 -3
- data/lib/flat_api/models/score_license.rb +1 -1
- data/lib/flat_api/models/score_likes_counts.rb +1 -1
- data/lib/flat_api/models/score_modification.rb +13 -20
- data/lib/flat_api/models/score_privacy.rb +1 -1
- data/lib/flat_api/models/score_revision.rb +1 -1
- data/lib/flat_api/models/score_revision_creation.rb +1 -1
- data/lib/flat_api/models/score_revision_statistics.rb +1 -1
- data/lib/flat_api/models/score_source.rb +1 -1
- data/lib/flat_api/models/score_summary.rb +1 -1
- data/lib/flat_api/models/score_track.rb +1 -1
- data/lib/flat_api/models/score_track_creation.rb +1 -1
- data/lib/flat_api/models/score_track_point.rb +1 -1
- data/lib/flat_api/models/score_track_state.rb +1 -1
- data/lib/flat_api/models/score_track_type.rb +1 -1
- data/lib/flat_api/models/score_track_update.rb +1 -1
- data/lib/flat_api/models/score_views_counts.rb +1 -1
- data/lib/flat_api/models/user_admin_update.rb +1 -1
- data/lib/flat_api/models/user_basics.rb +1 -1
- data/lib/flat_api/models/user_creation.rb +1 -1
- data/lib/flat_api/models/user_details.rb +1 -1
- data/lib/flat_api/models/user_details_admin.rb +1 -1
- data/lib/flat_api/models/user_details_admin_license.rb +1 -1
- data/lib/flat_api/models/user_instruments.rb +1 -1
- data/lib/flat_api/models/user_public.rb +1 -1
- data/lib/flat_api/models/user_public_summary.rb +1 -1
- data/lib/flat_api/version.rb +2 -2
- data/spec/api/account_api_spec.rb +2 -2
- data/spec/api/class_api_spec.rb +2 -2
- data/spec/api/collection_api_spec.rb +159 -0
- data/spec/api/group_api_spec.rb +2 -2
- data/spec/api/organization_api_spec.rb +2 -2
- data/spec/api/score_api_spec.rb +41 -26
- data/spec/api/user_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/assignment_copy_spec.rb +2 -2
- data/spec/models/assignment_creation_spec.rb +2 -2
- data/spec/models/assignment_spec.rb +2 -2
- data/spec/models/assignment_submission_spec.rb +2 -2
- data/spec/models/assignment_submission_update_spec.rb +2 -2
- data/spec/models/class_attachment_creation_spec.rb +2 -2
- data/spec/models/class_creation_spec.rb +2 -2
- data/spec/models/class_details_canvas_spec.rb +2 -2
- data/spec/models/class_details_clever_spec.rb +2 -2
- data/spec/models/class_details_google_classroom_spec.rb +2 -2
- data/spec/models/class_details_google_drive_spec.rb +2 -2
- data/spec/models/class_details_lti_spec.rb +2 -2
- data/spec/models/class_details_spec.rb +2 -2
- data/spec/models/class_roles_spec.rb +2 -2
- data/spec/models/class_state_spec.rb +2 -2
- data/spec/models/class_update_spec.rb +2 -2
- data/spec/models/collection_capabilities_spec.rb +66 -0
- data/spec/models/collection_creation_spec.rb +42 -0
- data/spec/models/collection_modification_spec.rb +42 -0
- data/spec/models/collection_privacy_spec.rb +36 -0
- data/spec/models/collection_spec.rb +102 -0
- data/spec/models/collection_title_spec.rb +36 -0
- data/spec/models/collection_type_spec.rb +36 -0
- data/spec/models/flat_error_response_spec.rb +2 -2
- data/spec/models/flat_locales_spec.rb +2 -2
- data/spec/models/google_classroom_coursework_spec.rb +2 -2
- data/spec/models/google_classroom_submission_spec.rb +2 -2
- data/spec/models/group_details_spec.rb +2 -2
- data/spec/models/group_spec.rb +2 -2
- data/spec/models/group_type_spec.rb +2 -2
- data/spec/models/license_mode_spec.rb +2 -2
- data/spec/models/license_sources_spec.rb +2 -2
- data/spec/models/lms_name_spec.rb +2 -2
- data/spec/models/lti_credentials_creation_spec.rb +2 -2
- data/spec/models/lti_credentials_spec.rb +2 -2
- data/spec/models/media_attachment_spec.rb +2 -2
- data/spec/models/media_score_sharing_mode_spec.rb +2 -2
- data/spec/models/organization_invitation_creation_spec.rb +2 -2
- data/spec/models/organization_invitation_spec.rb +2 -2
- data/spec/models/organization_roles_spec.rb +2 -2
- data/spec/models/{score_collaborator_creation_spec.rb → resource_collaborator_creation_spec.rb} +14 -8
- data/spec/models/{score_collaborator_spec.rb → resource_collaborator_spec.rb} +22 -16
- data/spec/models/{score_rights_spec.rb → resource_rights_spec.rb} +14 -8
- data/spec/models/resource_sharing_key_spec.rb +36 -0
- data/spec/models/score_comment_context_spec.rb +2 -2
- data/spec/models/score_comment_creation_spec.rb +2 -2
- data/spec/models/score_comment_spec.rb +2 -2
- data/spec/models/score_comment_update_spec.rb +2 -2
- data/spec/models/score_comments_counts_spec.rb +2 -2
- data/spec/models/score_creation_spec.rb +8 -2
- data/spec/models/score_creation_type_spec.rb +2 -2
- data/spec/models/score_data_encoding_spec.rb +2 -2
- data/spec/models/score_data_spec.rb +2 -2
- data/spec/models/score_details_spec.rb +2 -2
- data/spec/models/score_fork_spec.rb +8 -2
- data/spec/models/score_license_spec.rb +2 -2
- data/spec/models/score_likes_counts_spec.rb +2 -2
- data/spec/models/score_modification_spec.rb +8 -2
- data/spec/models/score_privacy_spec.rb +2 -2
- data/spec/models/score_revision_creation_spec.rb +2 -2
- data/spec/models/score_revision_spec.rb +2 -2
- data/spec/models/score_revision_statistics_spec.rb +2 -2
- data/spec/models/score_source_spec.rb +2 -2
- data/spec/models/score_summary_spec.rb +2 -2
- data/spec/models/score_track_creation_spec.rb +2 -2
- data/spec/models/score_track_point_spec.rb +2 -2
- data/spec/models/score_track_spec.rb +2 -2
- data/spec/models/score_track_state_spec.rb +2 -2
- data/spec/models/score_track_type_spec.rb +2 -2
- data/spec/models/score_track_update_spec.rb +2 -2
- data/spec/models/score_views_counts_spec.rb +2 -2
- data/spec/models/user_admin_update_spec.rb +2 -2
- data/spec/models/user_basics_spec.rb +2 -2
- data/spec/models/user_creation_spec.rb +2 -2
- data/spec/models/user_details_admin_license_spec.rb +2 -2
- data/spec/models/user_details_admin_spec.rb +2 -2
- data/spec/models/user_details_spec.rb +2 -2
- data/spec/models/user_instruments_spec.rb +2 -2
- data/spec/models/user_public_spec.rb +2 -2
- data/spec/models/user_public_summary_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +50 -15
- data/docs/ScoreCollaborator.md +0 -15
- data/docs/ScoreRights.md +0 -10
- data/git_push.sh +0 -55
data/spec/api/group_api_spec.rb
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
data/spec/api/score_api_spec.rb
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -34,11 +34,11 @@ describe 'ScoreApi' do
|
|
34
34
|
|
35
35
|
# unit tests for add_score_collaborator
|
36
36
|
# Add a new collaborator
|
37
|
-
# Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a
|
37
|
+
# Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a resource. - To add an existing Flat user to the resource, specify its unique identifier in the `user` property. - To invite an external user to the resource, specify its email in the `userEmail` property. - To add a Flat group to the resource, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights.
|
38
38
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
39
39
|
# @param body
|
40
40
|
# @param [Hash] opts the optional parameters
|
41
|
-
# @return [
|
41
|
+
# @return [ResourceCollaborator]
|
42
42
|
describe 'add_score_collaborator test' do
|
43
43
|
it "should work" do
|
44
44
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -60,7 +60,7 @@ describe 'ScoreApi' do
|
|
60
60
|
|
61
61
|
# unit tests for create_score
|
62
62
|
# Create a new score
|
63
|
-
# Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups).
|
63
|
+
# Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). If no `collection` is specified, the API will create the score in the most appropriate collection. This can be the `root` collection or a different collection based on the user's settings or API authentication method. If a `collection` is specified and this one has more public privacy settings than the score (e.g. `public` vs `private` for the score), the privacy settings of the created score will be adjusted to the collection ones. You can check the adjusted privacy settings in the returned score `privacy`, and optionally adjust these settings if needed using `PUT /scores/{score}`.
|
64
64
|
# @param body
|
65
65
|
# @param [Hash] opts the optional parameters
|
66
66
|
# @return [ScoreDetails]
|
@@ -85,7 +85,7 @@ describe 'ScoreApi' do
|
|
85
85
|
|
86
86
|
# unit tests for delete_score
|
87
87
|
# Delete a score
|
88
|
-
# This
|
88
|
+
# This method can be used by the owner/admin (`aclAdmin` rights) of a score as well as regular collaborators. When called by an owner/admin, it will schedule the deletion of the score, its revisions, and complete history. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. When called by a regular collaborator (`aclRead` / `aclWrite`), the score will be unshared (i.e. removed from the account & own collections).
|
89
89
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
90
90
|
# @param [Hash] opts the optional parameters
|
91
91
|
# @return [nil]
|
@@ -101,7 +101,7 @@ describe 'ScoreApi' do
|
|
101
101
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
102
102
|
# @param comment Unique identifier of a sheet music comment
|
103
103
|
# @param [Hash] opts the optional parameters
|
104
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
104
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
105
105
|
# @return [nil]
|
106
106
|
describe 'delete_score_comment test' do
|
107
107
|
it "should work" do
|
@@ -124,7 +124,7 @@ describe 'ScoreApi' do
|
|
124
124
|
|
125
125
|
# unit tests for edit_score
|
126
126
|
# Edit a score's metadata
|
127
|
-
# This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`).
|
127
|
+
# This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). When editing the `title` of the score, the API metadata are updated directly when calling this method, unlike the data itself. The title in the score data will be \"lazy\" updated at the next score save with the editor or our internal save.
|
128
128
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
129
129
|
# @param [Hash] opts the optional parameters
|
130
130
|
# @option opts [ScoreModification] :body
|
@@ -141,7 +141,7 @@ describe 'ScoreApi' do
|
|
141
141
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
142
142
|
# @param body
|
143
143
|
# @param [Hash] opts the optional parameters
|
144
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
144
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
145
145
|
# @return [ScoreDetails]
|
146
146
|
describe 'fork_score test' do
|
147
147
|
it "should work" do
|
@@ -180,7 +180,7 @@ describe 'ScoreApi' do
|
|
180
180
|
# Get the details of a score identified by the `score` parameter in the URL. The currently authenticated user must have at least a read access to the document to use this API call.
|
181
181
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
182
182
|
# @param [Hash] opts the optional parameters
|
183
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
183
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
184
184
|
# @return [ScoreDetails]
|
185
185
|
describe 'get_score test' do
|
186
186
|
it "should work" do
|
@@ -194,8 +194,8 @@ describe 'ScoreApi' do
|
|
194
194
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
195
195
|
# @param collaborator Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group**
|
196
196
|
# @param [Hash] opts the optional parameters
|
197
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
198
|
-
# @return [
|
197
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
198
|
+
# @return [ResourceCollaborator]
|
199
199
|
describe 'get_score_collaborator test' do
|
200
200
|
it "should work" do
|
201
201
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -207,8 +207,8 @@ describe 'ScoreApi' do
|
|
207
207
|
# This API call will list the different collaborators of a score and their rights on the document. The returned list will at least contain the owner of the document. Collaborators can be a single user (the object `user` will be populated) or a group (the object `group` will be populated).
|
208
208
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
209
209
|
# @param [Hash] opts the optional parameters
|
210
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
211
|
-
# @return [Array<
|
210
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
211
|
+
# @return [Array<ResourceCollaborator>]
|
212
212
|
describe 'get_score_collaborators test' do
|
213
213
|
it "should work" do
|
214
214
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -220,7 +220,10 @@ describe 'ScoreApi' do
|
|
220
220
|
# This method lists the different comments added on a music score (documents and inline) sorted by their post dates.
|
221
221
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
222
222
|
# @param [Hash] opts the optional parameters
|
223
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
223
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
224
|
+
# @option opts [String] :type Filter the comments by type
|
225
|
+
# @option opts [String] :sort Sort
|
226
|
+
# @option opts [String] :direction Sort direction
|
224
227
|
# @return [Array<ScoreComment>]
|
225
228
|
describe 'get_score_comments test' do
|
226
229
|
it "should work" do
|
@@ -234,7 +237,7 @@ describe 'ScoreApi' do
|
|
234
237
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
235
238
|
# @param revision Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
|
236
239
|
# @param [Hash] opts the optional parameters
|
237
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
240
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
238
241
|
# @return [ScoreRevision]
|
239
242
|
describe 'get_score_revision test' do
|
240
243
|
it "should work" do
|
@@ -249,9 +252,9 @@ describe 'ScoreApi' do
|
|
249
252
|
# @param revision Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created.
|
250
253
|
# @param format The format of the file you will retrieve
|
251
254
|
# @param [Hash] opts the optional parameters
|
252
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
253
|
-
# @option opts [BOOLEAN] :only_cached Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned
|
255
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
254
256
|
# @option opts [String] :parts An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\".
|
257
|
+
# @option opts [BOOLEAN] :only_cached Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned
|
255
258
|
# @return [String]
|
256
259
|
describe 'get_score_revision_data test' do
|
257
260
|
it "should work" do
|
@@ -264,7 +267,7 @@ describe 'ScoreApi' do
|
|
264
267
|
# When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification. Depending the plan of the account, this list can be trunked to the few last revisions.
|
265
268
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
266
269
|
# @param [Hash] opts the optional parameters
|
267
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
270
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
268
271
|
# @return [Array<ScoreRevision>]
|
269
272
|
describe 'get_score_revisions test' do
|
270
273
|
it "should work" do
|
@@ -290,7 +293,7 @@ describe 'ScoreApi' do
|
|
290
293
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
291
294
|
# @param track Unique identifier of a score audio track
|
292
295
|
# @param [Hash] opts the optional parameters
|
293
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
296
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
294
297
|
# @return [ScoreTrack]
|
295
298
|
describe 'get_score_track test' do
|
296
299
|
it "should work" do
|
@@ -300,7 +303,7 @@ describe 'ScoreApi' do
|
|
300
303
|
|
301
304
|
# unit tests for get_user_scores
|
302
305
|
# List user's scores
|
303
|
-
# Get the list of scores owned by
|
306
|
+
# Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead.
|
304
307
|
# @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
305
308
|
# @param [Hash] opts the optional parameters
|
306
309
|
# @option opts [String] :parent Filter the score forked from the score id `parent`
|
@@ -316,7 +319,7 @@ describe 'ScoreApi' do
|
|
316
319
|
#
|
317
320
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
318
321
|
# @param [Hash] opts the optional parameters
|
319
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
322
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
320
323
|
# @return [Array<ScoreTrack>]
|
321
324
|
describe 'list_score_tracks test' do
|
322
325
|
it "should work" do
|
@@ -330,7 +333,7 @@ describe 'ScoreApi' do
|
|
330
333
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
331
334
|
# @param comment Unique identifier of a sheet music comment
|
332
335
|
# @param [Hash] opts the optional parameters
|
333
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
336
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
334
337
|
# @return [nil]
|
335
338
|
describe 'mark_score_comment_resolved test' do
|
336
339
|
it "should work" do
|
@@ -344,7 +347,7 @@ describe 'ScoreApi' do
|
|
344
347
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
345
348
|
# @param comment Unique identifier of a sheet music comment
|
346
349
|
# @param [Hash] opts the optional parameters
|
347
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
350
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
348
351
|
# @return [nil]
|
349
352
|
describe 'mark_score_comment_unresolved test' do
|
350
353
|
it "should work" do
|
@@ -358,7 +361,7 @@ describe 'ScoreApi' do
|
|
358
361
|
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
359
362
|
# @param body
|
360
363
|
# @param [Hash] opts the optional parameters
|
361
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
364
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
362
365
|
# @return [ScoreComment]
|
363
366
|
describe 'post_score_comment test' do
|
364
367
|
it "should work" do
|
@@ -379,6 +382,18 @@ describe 'ScoreApi' do
|
|
379
382
|
end
|
380
383
|
end
|
381
384
|
|
385
|
+
# unit tests for untrash_score
|
386
|
+
# Untrash a score
|
387
|
+
# This method will remove the score from the `trash` collection and from the deletion queue, and add it back to the original collections.
|
388
|
+
# @param score Unique identifier of the score document. This can be a Flat Score unique identifier (i.e. `ScoreDetails.id`) or, if the score is also a Google Drive file, the Drive file unique identifier prefixed with `drive-` (e.g. `drive-0B000000000`).
|
389
|
+
# @param [Hash] opts the optional parameters
|
390
|
+
# @return [nil]
|
391
|
+
describe 'untrash_score test' do
|
392
|
+
it "should work" do
|
393
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
394
|
+
end
|
395
|
+
end
|
396
|
+
|
382
397
|
# unit tests for update_score_comment
|
383
398
|
# Update an existing comment
|
384
399
|
#
|
@@ -386,7 +401,7 @@ describe 'ScoreApi' do
|
|
386
401
|
# @param comment Unique identifier of a sheet music comment
|
387
402
|
# @param body
|
388
403
|
# @param [Hash] opts the optional parameters
|
389
|
-
# @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
404
|
+
# @option opts [String] :sharing_key This sharing key must be specified to access to a score or collection with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document.
|
390
405
|
# @return [ScoreComment]
|
391
406
|
describe 'update_score_comment test' do
|
392
407
|
it "should work" do
|
data/spec/api/user_api_spec.rb
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -59,7 +59,7 @@ describe 'UserApi' do
|
|
59
59
|
|
60
60
|
# unit tests for get_user_scores
|
61
61
|
# List user's scores
|
62
|
-
# Get the list of scores owned by
|
62
|
+
# Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead.
|
63
63
|
# @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user.
|
64
64
|
# @param [Hash] opts the optional parameters
|
65
65
|
# @option opts [String] :parent Filter the score forked from the score id `parent`
|
data/spec/api_client_spec.rb
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
data/spec/configuration_spec.rb
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments. The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference). Getting Started and learn more: * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html)
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.6.0
|
7
7
|
Contact: developers@flat.io
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.
|
9
|
+
Swagger Codegen version: 2.4.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|