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":{"minor":3,"patch":0,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/postaccesstoken\/output"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Enumeration","modules":[{"name":"DiscogsService"}],"symbolKind":"enum","externalID":"s:14DiscogsService10OperationsO15PostAccessTokenO6OutputO","title":"Operations.PostAccessToken.Output","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}]},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/Ok-swift.struct"],"generated":true,"anchor":"Structures","title":"Structures"},{"anchor":"Enumeration-Cases","title":"Enumeration Cases","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/internalServerError(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/ok(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/undocumented(statusCode:_:)"]},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/internalServerError","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/ok-swift.property"],"title":"Instance Properties","anchor":"Instance-Properties"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/Equatable-Implementations"],"title":"Default Implementations","anchor":"Default-Implementations"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"@frozen","kind":"attribute"},{"text":" ","kind":"text"},{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Output"}],"platforms":["macOS"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output"},"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostAccessToken/Output":{"abstract":[],"title":"Operations.PostAccessToken.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output","url":"\/documentation\/discogsservice\/operations\/postaccesstoken\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostAccessToken":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PostAccessToken"}],"title":"Operations.PostAccessToken","abstract":[{"text":"Provide required credentials data to obtain an access token.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken","role":"symbol","navigatorTitle":[{"text":"PostAccessToken","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/postaccesstoken"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostAccessToken/Output/ok(_:)":{"url":"\/documentation\/discogsservice\/operations\/postaccesstoken\/output\/ok(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/ok(_:)","abstract":[{"text":"Successfully retrieved an access token at the end of the OAuth authentication process.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"text":"PostAccessToken","preciseIdentifier":"s:14DiscogsService10OperationsO15PostAccessTokenO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostAccessTokenO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostAccessTokenO6OutputO2OkV"},{"kind":"text","text":")"}],"title":"Operations.PostAccessToken.Output.ok(_:)","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostAccessToken/Output/Ok-swift.struct":{"abstract":[],"title":"Operations.PostAccessToken.Output.Ok","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/postaccesstoken\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/Ok-swift.struct","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostAccessToken/Output/undocumented(statusCode:_:)":{"url":"\/documentation\/discogsservice\/operations\/postaccesstoken\/output\/undocumented(statuscode:_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/undocumented(statusCode:_:)","abstract":[{"text":"Undocumented response.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","kind":"typeIdentifier"},{"kind":"text","text":")"}],"type":"topic","title":"Operations.PostAccessToken.Output.undocumented(statusCode:_:)"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"},"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":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostAccessToken/Output/internalServerError(_:)":{"abstract":[{"text":"An Internal Server error was encountered.","type":"text"}],"title":"Operations.PostAccessToken.Output.internalServerError(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"internalServerError","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":"InternalError","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/internalServerError(_:)","url":"\/documentation\/discogsservice\/operations\/postaccesstoken\/output\/internalservererror(_:)","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostAccessToken/Output/internalServerError":{"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"type":"codeVoice","code":".internalServerError"},{"text":".","type":"text"}],"title":"internalServerError","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"internalServerError"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses"},{"kind":"text","text":"."},{"text":"InternalError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/internalServerError","url":"\/documentation\/discogsservice\/operations\/postaccesstoken\/output\/internalservererror","type":"topic","kind":"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/PostAccessToken/Output/ok-swift.property":{"url":"\/documentation\/discogsservice\/operations\/postaccesstoken\/output\/ok-swift.property","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/ok-swift.property","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostAccessToken","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostAccessTokenO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostAccessTokenO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostAccessTokenO6OutputO2OkV"}],"type":"topic","title":"ok"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostAccessToken/Output/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/operations\/postaccesstoken\/output\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostAccessToken\/Output\/Equatable-Implementations","abstract":[],"kind":"article","role":"collectionGroup","title":"Equatable Implementations","type":"topic"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable"}}} |