2a7b9746a7
This PR contains the work done to implement the *User Collection* endpoints of the Discogs API into the `OpenAPI` specification document:
* GET `/users/{username}/collection/folders`
* POST `/users/{username}/collection/folders`
* GET `/users/{username}/collection/folders/{folder_id}`
* POST `/users/{username}/collection/folders/{folder_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}`
* GET `/users/{username}/collection/releases/{release_id}`
* GET `/users/{username}/collection/folders/{folder_id}/releases`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* GET `/users/{username}/collection/fields`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}/fields/{field_id}`
* GET `/users/{username}/collection/value`
Reviewed-on: #12
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
11 KiB
JSON
1 line
11 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ReleaseRatingByUser"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"level":2,"anchor":"overview","text":"Overview","type":"heading"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/components\/schemas\/ReleaseRatingByUser"},{"text":".","type":"text"}]}],"style":"note","type":"aside"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser"},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo"}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseratingbyuser"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"topicSections":[{"title":"Initializers","anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/init(username:releaseId:rating:)"],"generated":true},{"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/rating","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/releaseId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/username"],"generated":true},{"title":"Enumerations","anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/CodingKeys"],"generated":true},{"title":"Default Implementations","anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/Equatable-Implementations"],"generated":true}],"abstract":[{"text":"A type that represents a rating of a release by a user.","type":"text"}],"metadata":{"symbolKind":"struct","modules":[{"name":"DiscogsService"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ReleaseRatingByUser"}],"role":"symbol","roleHeading":"Structure","externalID":"s:14DiscogsService10ComponentsO7SchemasO19ReleaseRatingByUserV","title":"Components.Schemas.ReleaseRatingByUser","navigatorTitle":[{"text":"ReleaseRatingByUser","kind":"identifier"}]},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseRatingByUser/rating":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rating","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseratingbyuser\/rating","title":"rating","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/rating","abstract":[{"type":"text","text":"A number that defines a rating value of a release."}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseRatingByUser/username":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/username","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"username","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/discogsservice\/components\/schemas\/releaseratingbyuser\/username","role":"symbol","title":"username","type":"topic","abstract":[{"text":"A username of a user.","type":"text"}]},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseRatingByUser/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/Equatable-Implementations","kind":"article","url":"\/documentation\/discogsservice\/components\/schemas\/releaseratingbyuser\/equatable-implementations","role":"collectionGroup","title":"Equatable Implementations","type":"topic","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseRatingByUser/init(from:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseratingbyuser\/init(from:)","abstract":[],"kind":"symbol","type":"topic","title":"init(from:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseRatingByUser/releaseId":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseratingbyuser\/releaseid","abstract":[{"text":"An identifier of a release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/releaseId","title":"releaseId","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"releaseId","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}]},"doc://DiscogsService/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/DiscogsService\/Se","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"title":"Components.Schemas","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseRatingByUser/init(username:releaseId:rating:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"releaseId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rating","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/init(username:releaseId:rating:)","kind":"symbol","title":"init(username:releaseId:rating:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"ReleaseRatingByUser"},{"type":"text","text":"."}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/releaseratingbyuser\/init(username:releaseid:rating:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseRatingByUser":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseratingbyuser","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser","abstract":[{"text":"A type that represents a rating of a release by a user.","type":"text"}],"title":"Components.Schemas.ReleaseRatingByUser","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseRatingByUser","kind":"identifier"}],"navigatorTitle":[{"text":"ReleaseRatingByUser","kind":"identifier"}]},"doc://DiscogsService/SE":{"title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components":{"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Components"}],"role":"symbol","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","navigatorTitle":[{"kind":"identifier","text":"Components"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseRatingByUser/CodingKeys":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/releaseratingbyuser\/codingkeys","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseRatingByUser\/CodingKeys","abstract":[],"title":"Components.Schemas.ReleaseRatingByUser.CodingKeys","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}]}}} |