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
8.6 KiB
JSON
1 line
8.6 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"abstract":[{"text":"A type that contains any error data.","type":"text"}],"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ServiceError","kind":"identifier"}]}]},{"kind":"content","content":[{"level":2,"text":"Overview","type":"heading","anchor":"overview"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/schemas\/ServiceError","type":"codeVoice"},{"type":"text","text":"."}]}],"type":"aside","style":"note"}]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo"}],"topicSections":[{"generated":true,"anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/init(message:)"],"title":"Initializers"},{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/message"],"title":"Instance Properties"},{"title":"Enumerations","anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/CodingKeys"],"generated":true},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/Equatable-Implementations"],"generated":true}],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/serviceerror"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV","symbolKind":"struct","title":"Components.Schemas.ServiceError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ServiceError","kind":"identifier"}],"navigatorTitle":[{"text":"ServiceError","kind":"identifier"}]},"references":{"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ServiceError/Equatable-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/serviceerror\/equatable-implementations","title":"Equatable Implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/Equatable-Implementations","abstract":[],"role":"collectionGroup"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ServiceError":{"navigatorTitle":[{"text":"ServiceError","kind":"identifier"}],"type":"topic","title":"Components.Schemas.ServiceError","url":"\/documentation\/discogsservice\/components\/schemas\/serviceerror","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ServiceError","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A type that contains any error data.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ServiceError/CodingKeys":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/CodingKeys","kind":"symbol","title":"Components.Schemas.ServiceError.CodingKeys","abstract":[],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/serviceerror\/codingkeys","type":"topic"},"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/ServiceError/init(message:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"message","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/serviceerror\/init(message:)","title":"init(message:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/init(message:)","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"ServiceError"},{"type":"text","text":"."}],"role":"symbol"},"doc://DiscogsService/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se"},"doc://DiscogsService/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SE"},"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":{"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/ServiceError/init(from:)":{"kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/serviceerror\/init(from:)","title":"init(from:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/init(from:)","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ServiceError/message":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"message","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/serviceerror\/message","title":"message","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError\/message","abstract":[{"text":"A message of a service error.","type":"text"}],"role":"symbol"}}} |