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
12 KiB
JSON
1 line
12 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MasterResult","kind":"identifier"}]}]},{"kind":"content","content":[{"level":2,"anchor":"overview","text":"Overview","type":"heading"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/MasterResult"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"topicSections":[{"title":"Structures","anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/Value2Payload"],"generated":true},{"title":"Initializers","anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/init(value1:value2:)"],"generated":true},{"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/value1","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/value2"],"generated":true},{"title":"Instance Methods","anchor":"Instance-Methods","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/encode(to:)"],"generated":true},{"title":"Default Implementations","anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/Equatable-Implementations"],"generated":true}],"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/masterresult"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"roleHeading":"Structure","symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MasterResult","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"text":"MasterResult","kind":"identifier"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO12MasterResultV","title":"Components.Schemas.MasterResult","role":"symbol"},"abstract":[{"text":"A type that represents a master search result.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult"},"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"references":{"doc://DiscogsService/Se":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/MasterResult/encode(to:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/masterresult\/encode(to:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7EncoderP","kind":"typeIdentifier","text":"Encoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","title":"encode(to:)","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/encode(to:)","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/MasterResult/Value2Payload":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/Value2Payload","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Value2Payload"}],"url":"\/documentation\/discogsservice\/components\/schemas\/masterresult\/value2payload","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Value2Payload"}],"title":"Components.Schemas.MasterResult.Value2Payload","type":"topic","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/MasterResult/init(value1:value2:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"value1","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"SearchResult","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12SearchResultV"},{"text":", ","kind":"text"},{"text":"value2","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"MasterResult","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12MasterResultV"},{"text":".","kind":"text"},{"text":"Value2Payload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12MasterResultV13Value2PayloadV"},{"text":")","kind":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/masterresult\/init(value1:value2:)","title":"init(value1:value2:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/init(value1:value2:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"MasterResult","type":"codeVoice"},{"type":"text","text":"."}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/MasterResult/value1":{"url":"\/documentation\/discogsservice\/components\/schemas\/masterresult\/value1","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"value1"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12SearchResultV","kind":"typeIdentifier","text":"SearchResult"}],"kind":"symbol","title":"value1","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/value1","abstract":[],"role":"symbol"},"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/MasterResult":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MasterResult","kind":"identifier"}],"navigatorTitle":[{"text":"MasterResult","kind":"identifier"}],"abstract":[{"text":"A type that represents a master search result.","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/masterresult","title":"Components.Schemas.MasterResult","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/MasterResult/init(from:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/masterresult\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","title":"init(from:)","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/init(from:)","abstract":[],"role":"symbol"},"doc://DiscogsService/SE":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SE","title":"Swift.Encodable"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/MasterResult/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/masterresult\/equatable-implementations","kind":"article","title":"Equatable Implementations","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/Equatable-Implementations","abstract":[],"role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"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/documentation/DiscogsService/Components/Schemas/MasterResult/value2":{"url":"\/documentation\/discogsservice\/components\/schemas\/masterresult\/value2","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"value2"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12MasterResultV","kind":"typeIdentifier","text":"MasterResult"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12MasterResultV13Value2PayloadV","kind":"typeIdentifier","text":"Value2Payload"}],"kind":"symbol","title":"value2","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/MasterResult\/value2","abstract":[],"role":"symbol"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"}}} |