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":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"artists"},{"kind":"text","text":": ["},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"Artist","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6ArtistV"},{"text":"]? = nil, ","kind":"text"},{"text":"labels","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"Label","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Label","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO5LabelV"},{"text":"]? = nil, ","kind":"text"},{"text":"releases","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV","text":"Release","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release","kind":"typeIdentifier"},{"text":"]? = nil)","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"name":"artists","content":[{"inlineContent":[{"text":"A list of artists added and\/or edited by a user.","type":"text"}],"type":"paragraph"}]},{"name":"labels","content":[{"inlineContent":[{"text":"A list of labels added and\/or edited by a user.","type":"text"}],"type":"paragraph"}]},{"name":"releases","content":[{"type":"paragraph","inlineContent":[{"text":"A list of releases added and\/or edited by a user.","type":"text"}]}]}],"kind":"parameters"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserItems"]]},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserItems\/init(artists:labels:releases:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/useritems\/init(artists:labels:releases:)"]}],"sections":[],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"UserItems","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"modules":[{"name":"DiscogsService"}],"symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"artists"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6ArtistV","text":"Artist"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"labels"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO5LabelV","text":"Label"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"releases"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV","text":"Release"},{"kind":"text","text":"]?)"}],"role":"symbol","externalID":"s:14DiscogsService10ComponentsO7SchemasO9UserItemsV7artists6labels8releasesAGSayAE6ArtistVGSg_SayAE5LabelVGSgSayAE7ReleaseVGSgtcfc","title":"init(artists:labels:releases:)","roleHeading":"Initializer"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Label":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Label","kind":"identifier"}],"title":"Components.Schemas.Label","abstract":[{"text":"A type that represents a label, company, recording studio, etc.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Label","role":"symbol","navigatorTitle":[{"text":"Label","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/label"},"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/UserItems/init(artists:labels:releases:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"artists","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO6ArtistV","text":"Artist"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"labels"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO5LabelV","text":"Label"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"releases"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"text":"Release","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV","kind":"typeIdentifier"},{"kind":"text","text":"]?)"}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserItems"},{"type":"text","text":"."}],"kind":"symbol","type":"topic","title":"init(artists:labels:releases:)","url":"\/documentation\/discogsservice\/components\/schemas\/useritems\/init(artists:labels:releases:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserItems\/init(artists:labels:releases:)","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Release":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"A type that eepresents a particular physical or digital object released by one or more artists."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release","url":"\/documentation\/discogsservice\/components\/schemas\/release","title":"Components.Schemas.Release","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Release"}],"navigatorTitle":[{"kind":"identifier","text":"Release"}]},"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/UserItems":{"abstract":[{"type":"text","text":"A type that represents all items added and\/or edited by a user."}],"title":"Components.Schemas.UserItems","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserItems","kind":"identifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/useritems","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/UserItems","navigatorTitle":[{"text":"UserItems","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Artist","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/artist","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Artist"}],"title":"Components.Schemas.Artist","type":"topic","abstract":[{"type":"text","text":"A type that represents an artist or a group."}]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}} |