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
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"attribute","text":"@frozen"},{"kind":"text","text":" "},{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Output"}],"platforms":["macOS"],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases"]]},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getlabelreleases\/output"]}],"sections":[],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/Ok-swift.struct"],"generated":true,"anchor":"Structures","title":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/notFound(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/ok(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/undocumented(statusCode:_:)"],"title":"Enumeration Cases","generated":true,"anchor":"Enumeration-Cases"},{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/notFound","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/ok-swift.property"],"generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/Equatable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"metadata":{"modules":[{"name":"DiscogsService"}],"symbolKind":"enum","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Output"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO16GetLabelReleasesO6OutputO","title":"Operations.GetLabelReleases.Output","roleHeading":"Enumeration","navigatorTitle":[{"text":"Output","kind":"identifier"}]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Output/Ok-swift.struct":{"navigatorTitle":[{"text":"Ok","kind":"identifier"}],"type":"topic","title":"Operations.GetLabelReleases.Output.Ok","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/Ok-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Output/notFound":{"title":"notFound","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".notFound","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/notfound","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"notFound"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Responses","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"NotFound","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/notFound"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetLabelReleases"}],"navigatorTitle":[{"kind":"identifier","text":"GetLabelReleases"}],"abstract":[{"type":"text","text":"Get information about the releases of a label."}],"kind":"symbol","type":"topic","title":"Operations.GetLabelReleases","url":"\/documentation\/discogsservice\/operations\/getlabelreleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Output/ok(_:)":{"type":"topic","title":"Operations.GetLabelReleases.Output.ok(_:)","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/ok(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/ok(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO16GetLabelReleasesO","text":"GetLabelReleases","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO16GetLabelReleasesO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO16GetLabelReleasesO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A paginated list of the label’s releases.","type":"text"}]},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"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/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Output/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/Equatable-Implementations","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/equatable-implementations","role":"collectionGroup","title":"Equatable Implementations","type":"topic","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Output/undocumented(statusCode:_:)":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/undocumented(statusCode:_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"UndocumentedPayload","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV"},{"text":")","kind":"text"}],"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/undocumented(statuscode:_:)","role":"symbol","title":"Operations.GetLabelReleases.Output.undocumented(statusCode:_:)","type":"topic","abstract":[{"type":"text","text":"Undocumented response."}]},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable","type":"unresolvable"},"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/GetLabelReleases/Output/notFound(_:)":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/notfound(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Responses","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"NotFound","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","title":"Operations.GetLabelReleases.Output.notFound(_:)","abstract":[{"type":"text","text":"A requested resource cannot be found."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/notFound(_:)","type":"topic","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Output/ok-swift.property":{"type":"topic","title":"ok","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output\/ok-swift.property","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output\/ok-swift.property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16GetLabelReleasesO","kind":"typeIdentifier","text":"GetLabelReleases"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16GetLabelReleasesO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO16GetLabelReleasesO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"}],"kind":"symbol","role":"symbol","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".ok","type":"codeVoice"},{"text":".","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Output":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","title":"Operations.GetLabelReleases.Output","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[]},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"}}} |