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
13 KiB
JSON
1 line
13 KiB
JSON
{"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","sections":[],"topicSections":[{"generated":true,"title":"Structures","anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/Headers-swift.struct"]},{"generated":true,"title":"Initializers","anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/init(headers:body:)"]},{"generated":true,"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/body-swift.property","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/headers-swift.property"]},{"generated":true,"title":"Enumerations","anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/Body-swift.enum"]},{"generated":true,"title":"Default Implementations","anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/Equatable-Implementations"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"platforms":["macOS"]}]}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionfolders\/output\/ok-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"Operations.GetCollectionFolders.Output.Ok","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO2OkV","symbolKind":"struct","role":"symbol","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"navigatorTitle":[{"text":"Ok","kind":"identifier"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output"]]},"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Output/Ok-swift.struct/Equatable-Implementations":{"title":"Equatable Implementations","abstract":[],"kind":"article","role":"collectionGroup","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output\/ok-swift.struct\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/Equatable-Implementations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Output/Ok-swift.struct/init(headers:body:)":{"title":"init(headers:body:)","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Ok"},{"text":".","type":"text"}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output\/ok-swift.struct\/init(headers:body:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","kind":"typeIdentifier","text":"GetCollectionFolders"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO2OkV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":", "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","kind":"typeIdentifier","text":"GetCollectionFolders"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO2OkV4BodyO","kind":"typeIdentifier","text":"Body"},{"kind":"text","text":")"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/init(headers:body:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Output/Ok-swift.struct/Body-swift.enum":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"navigatorTitle":[{"kind":"identifier","text":"Body"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetCollectionFolders.Output.Ok.Body","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output\/ok-swift.struct\/body-swift.enum","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/Body-swift.enum","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Output/Ok-swift.struct/headers-swift.property":{"title":"headers","abstract":[{"text":"Received HTTP response headers","type":"text"}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output\/ok-swift.struct\/headers-swift.property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","kind":"typeIdentifier","text":"GetCollectionFolders"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO2OkV7HeadersV","kind":"typeIdentifier","text":"Headers"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/headers-swift.property"},"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/GetCollectionFolders/Output":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetCollectionFolders.Output","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output","role":"symbol"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Output/Ok-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetCollectionFolders.Output.Ok","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Output/Ok-swift.struct/body-swift.property":{"title":"body","abstract":[{"text":"Received HTTP response body","type":"text"}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output\/ok-swift.struct\/body-swift.property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","kind":"typeIdentifier","text":"GetCollectionFolders"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO2OkV4BodyO","kind":"typeIdentifier","text":"Body"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/body-swift.property"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Output/Ok-swift.struct/Headers-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"type":"topic","title":"Operations.GetCollectionFolders.Output.Ok.Headers","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output\/ok-swift.struct\/headers-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output\/Ok-swift.struct\/Headers-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"kind":"symbol","role":"symbol","abstract":[]},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders","abstract":[{"text":"Get all the collection folders of a user.","type":"text"}],"title":"Operations.GetCollectionFolders","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetCollectionFolders"}],"navigatorTitle":[{"kind":"identifier","text":"GetCollectionFolders"}]}}} |