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
17 KiB
JSON
1 line
17 KiB
JSON
{"metadata":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"symbolKind":"enum","title":"Operations.EditFieldsInstance.Output","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO18EditFieldsInstanceO6OutputO","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"roleHeading":"Enumeration","role":"symbol"},"topicSections":[{"anchor":"Structures","title":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/NoContent-swift.struct"],"generated":true},{"anchor":"Enumeration-Cases","title":"Enumeration Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/forbidden(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/internalServerError(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/noContent(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/notFound(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/undocumented(statusCode:_:)"],"generated":true},{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/forbidden","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/internalServerError","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/noContent-swift.property","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/notFound"],"generated":true},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/Equatable-Implementations"],"generated":true}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"@frozen","kind":"attribute"},{"text":" ","kind":"text"},{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/editfieldsinstance\/output"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output/notFound":{"type":"topic","title":"notFound","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/notFound","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/notfound","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotFound","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"code":".notFound","type":"codeVoice"},{"type":"text","text":"."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output/undocumented(statusCode:_:)":{"type":"topic","title":"Operations.EditFieldsInstance.Output.undocumented(statusCode:_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/undocumented(statusCode:_:)","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/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"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Undocumented response."}]},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable","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/documentation/DiscogsService/Operations/EditFieldsInstance/Output/NoContent-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NoContent","kind":"identifier"}],"title":"Operations.EditFieldsInstance.Output.NoContent","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/NoContent-swift.struct","role":"symbol","navigatorTitle":[{"text":"NoContent","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/nocontent-swift.struct"},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output/forbidden":{"type":"topic","title":"forbidden","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/forbidden","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/forbidden","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotAccessable","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"code":".forbidden","type":"codeVoice"},{"type":"text","text":"."}]},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output/noContent-swift.property":{"type":"topic","title":"noContent","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/noContent-swift.property","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/nocontent-swift.property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noContent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"EditFieldsInstance","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18EditFieldsInstanceO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18EditFieldsInstanceO6OutputO"},{"text":".","kind":"text"},{"text":"NoContent","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18EditFieldsInstanceO6OutputO9NoContentV"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"code":".noContent","type":"codeVoice"},{"type":"text","text":"."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"EditFieldsInstance"}],"url":"\/documentation\/discogsservice\/operations\/editfieldsinstance","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"EditFieldsInstance"}],"title":"Operations.EditFieldsInstance","type":"topic","abstract":[{"text":"Update a value of a custom field assigned to a release instance.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output":{"url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.EditFieldsInstance.Output","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output/forbidden(_:)":{"type":"topic","title":"Operations.EditFieldsInstance.Output.forbidden(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/forbidden(_:)","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/forbidden(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotAccessable","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV"},{"text":")","kind":"text"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A requested resource cannot be accessed due to a lack of permission."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output/noContent(_:)":{"type":"topic","title":"Operations.EditFieldsInstance.Output.noContent(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/noContent(_:)","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/nocontent(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noContent","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"EditFieldsInstance","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18EditFieldsInstanceO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18EditFieldsInstanceO6OutputO"},{"text":".","kind":"text"},{"text":"NoContent","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18EditFieldsInstanceO6OutputO9NoContentV"},{"text":")","kind":"text"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Successfully updated a value of a custom notes field for a release instance in a collection folder."}]},"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/EditFieldsInstance/Output/notFound(_:)":{"type":"topic","title":"Operations.EditFieldsInstance.Output.notFound(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/notFound(_:)","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/notfound(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotFound","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV"},{"text":")","kind":"text"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"A requested resource cannot be found."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output/internalServerError":{"type":"topic","title":"internalServerError","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/internalServerError","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/internalservererror","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"internalServerError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"InternalError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"code":".internalServerError","type":"codeVoice"},{"type":"text","text":"."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output/internalServerError(_:)":{"abstract":[{"type":"text","text":"An Internal Server error was encountered."}],"title":"Operations.EditFieldsInstance.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","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"InternalError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"},{"text":")","kind":"text"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/internalServerError(_:)","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/internalservererror(_:)","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/EditFieldsInstance/Output/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditFieldsInstance\/Output\/Equatable-Implementations","url":"\/documentation\/discogsservice\/operations\/editfieldsinstance\/output\/equatable-implementations","kind":"article","role":"collectionGroup","abstract":[]}}} |