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
{"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct"]]},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"metadata":{"title":"init(headers:body:)","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"PostCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV7HeadersV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"PostCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV4BodyO"},{"kind":"text","text":")"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV7headers4bodyA2I7HeadersV_AI4BodyOtcfc","modules":[{"name":"DiscogsService"}],"symbolKind":"init"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/postcollectionfolder\/output\/ok-swift.struct\/init(headers:body:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO","text":"PostCollectionFolder","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO","text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV","text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV7HeadersV","text":"Headers","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct\/Headers-swift.struct"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO","text":"PostCollectionFolder","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO","text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV","text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV4BodyO","text":"Body","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct\/Body-swift.enum"},{"text":")","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Received HTTP response headers","type":"text"}],"type":"paragraph"}],"name":"headers"},{"content":[{"inlineContent":[{"text":"Received HTTP response body","type":"text"}],"type":"paragraph"}],"name":"body"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct\/init(headers:body:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolder/Output/Ok-swift.struct/init(headers:body:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postcollectionfolder\/output\/ok-swift.struct\/init(headers:body:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct\/init(headers:body:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Ok","type":"codeVoice"},{"text":".","type":"text"}],"title":"init(headers:body:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostCollectionFolder","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV7HeadersV","text":"Headers"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"text":"PostCollectionFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO","text":"Output"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO20PostCollectionFolderO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolder/Output/Ok-swift.struct":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postcollectionfolder\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct","abstract":[],"title":"Operations.PostCollectionFolder.Output.Ok","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"navigatorTitle":[{"text":"Ok","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/Operations/PostCollectionFolder/Output/Ok-swift.struct/Headers-swift.struct":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postcollectionfolder\/output\/ok-swift.struct\/headers-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct\/Headers-swift.struct","abstract":[],"title":"Operations.PostCollectionFolder.Output.Ok.Headers","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolder/Output/Ok-swift.struct/Body-swift.enum":{"navigatorTitle":[{"kind":"identifier","text":"Body"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/postcollectionfolder\/output\/ok-swift.struct\/body-swift.enum","title":"Operations.PostCollectionFolder.Output.Ok.Body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output\/Ok-swift.struct\/Body-swift.enum","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolder":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PostCollectionFolder","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/postcollectionfolder","role":"symbol","navigatorTitle":[{"text":"PostCollectionFolder","kind":"identifier"}],"title":"Operations.PostCollectionFolder","type":"topic","abstract":[{"type":"text","text":"Update information about a collection folder of a user."}]},"doc://DiscogsService/documentation/DiscogsService/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolder/Output":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postcollectionfolder\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolder\/Output","abstract":[],"title":"Operations.PostCollectionFolder.Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}]}}} |