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