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