Skip to content

Commit 6d7ccdb

Browse files
committed
update(client): regenerate from api specs
1 parent b8f19a6 commit 6d7ccdb

46 files changed

Lines changed: 326 additions & 133 deletions

Some content is hidden

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

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Changelog
2+
3+
## 0.2.0
4+
5+
* feat(scores): add support of private links sharing with `sharingKey`.
6+
* feat(comments): Make "revision" optional when creating comments and support of "last" keyword.
7+
* fix(revisions): Missing `id` property in `ScoreRevision`.
8+
* update(spec): Specify `binary` response type for `GET /scores/{score}/revisions/{revision}/{format}`
9+
10+
## 0.1.0
11+
12+
Initial release

docs/ScoreApi.md

Lines changed: 77 additions & 27 deletions
Large diffs are not rendered by default.

docs/ScoreCommentCreation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**revision** | **String** | The unique indentifier of the revision of the score where the comment was added |
6+
**revision** | **String** | The unique indentifier of the revision of the score where the comment was added. If this property is unspecified or contains \"last\", the API will automatically take the last revision created. | [optional]
77
**comment** | **String** | The comment text that can includes mentions using the following format: `@[id:username]`. |
88
**rawComment** | **String** | A raw version of the comment, that can be displayed without the mentions. If you use mentions, this property must be set. | [optional]
99
**mentions** | **[String]** | The list of user identifiers mentioned in this comment | [optional]

docs/ScoreCommentUpdate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**revision** | **String** | The unique indentifier of the revision of the score where the comment was added | [optional]
6+
**revision** | **String** | The unique indentifier of the revision of the score where the comment was added. If this property is unspecified or contains \"last\", the API will automatically take the last revision created. | [optional]
77
**comment** | **String** | The comment text that can includes mentions using the following format: `@[id:username]`. | [optional]
88
**rawComment** | **String** | A raw version of the comment, that can be displayed without the mentions. If you use mentions, this property must be set. | [optional]
99
**context** | [**ScoreCommentContext**](ScoreCommentContext.md) | | [optional]

docs/ScoreModification.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**privacy** | [**ScorePrivacy**](ScorePrivacy.md) | | [optional]
77
**title** | **String** | A new title of the score | [optional]
8+
**sharingKey** | **String** | When using the `privacy` mode `privateLink`, this property can be used to set a custom sharing key, otherwise a new key will be generated. | [optional]
89

910

docs/ScorePrivacy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@
99

1010
* `organizationPublic` (value: `"organizationPublic"`)
1111

12+
* `privateLink` (value: `"privateLink"`)
13+
1214

docs/ScoreRevision.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | The unique identifier of the revision. | [optional]
67
**user** | **String** | The user identifier who created the revision | [optional]
78
**collaborators** | **[String]** | | [optional]
89
**creationDate** | **Date** | The date when this revision was created | [optional]

docs/ScoreSummary.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**id** | **String** | The unique identifier of the score | [optional]
7+
**sharingKey** | **String** | The private sharing key of the score (available when the `privacy` mode is set to `privateLink`) | [optional]
78
**title** | **String** | The title of the score | [optional]
89
**privacy** | [**ScorePrivacy**](ScorePrivacy.md) | | [optional]
910
**user** | [**UserPublicSummary**](UserPublicSummary.md) | | [optional]

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "flat-api",
3-
"version": "0.1.0",
3+
"version": "0.2.0",
44
"description": "JavaScript Client for Flat REST API (https://flat.io)",
55
"license": "Apache-2.0",
66
"repository": "https://github.com/FlatIO/api-client-js.git",

src/ApiClient.js

Lines changed: 45 additions & 7 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)