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.2 KiB
JSON
1 line
8.2 KiB
JSON
{"sections":[],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV4BodyO4jsonAC7SchemasO0B5ErrorVvp","symbolKind":"property","title":"json","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"json","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"ServiceError","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV"}]},"abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"code":".json","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"ServiceError","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"name":"Throws","type":"aside","content":[{"inlineContent":[{"text":"An error if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is not ","type":"text"},{"type":"codeVoice","code":".json"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"code":".json","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"See Also","type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/responses\/notfound\/body-swift.enum\/json"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum\/json","interfaceLanguage":"swift"},"references":{"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/Responses/NotFound":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotFound"}],"title":"Components.Responses.NotFound","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"NotFound"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/responses\/notfound"},"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":{"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":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses":{"navigatorTitle":[{"text":"Responses","kind":"identifier"}],"type":"topic","title":"Components.Responses","url":"\/documentation\/discogsservice\/components\/responses","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Responses","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/responses","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/NotFound/Body-swift.enum":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"title":"Components.Responses.NotFound.Body","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum","role":"symbol","navigatorTitle":[{"text":"Body","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/responses\/notfound\/body-swift.enum","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/NotFound/Body-swift.enum/json":{"url":"\/documentation\/discogsservice\/components\/responses\/notfound\/body-swift.enum\/json","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"json","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"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV","text":"ServiceError","kind":"typeIdentifier"}],"kind":"symbol","title":"json","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum\/json","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".json","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol"}}} |