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