eaee2b84f0
This PR contains the work done to update the overall documentation of the package. Reviewed-on: #17 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
18 KiB
JSON
1 line
18 KiB
JSON
{"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder"]]},"kind":"symbol","topicSections":[{"anchor":"Structures","title":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/Ok-swift.struct"],"generated":true},{"anchor":"Enumeration-Cases","title":"Enumeration Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/forbidden(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/internalServerError(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/notFound(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/ok(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/unauthorized(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/undocumented(statusCode:_:)"],"generated":true},{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/forbidden","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/internalServerError","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/notFound","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/ok-swift.property","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/unauthorized"],"generated":true},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/Equatable-Implementations"],"generated":true}],"metadata":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"roleHeading":"Enumeration","role":"symbol","modules":[{"name":"DiscogsService"}],"title":"Operations.GetOrder.Output","externalID":"s:14DiscogsService10OperationsO8GetOrderO6OutputO","symbolKind":"enum","navigatorTitle":[{"kind":"identifier","text":"Output"}]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"attribute","text":"@frozen"},{"kind":"text","text":" "},{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getorder\/output"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output":{"abstract":[],"url":"\/documentation\/discogsservice\/operations\/getorder\/output","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"role":"symbol","title":"Operations.GetOrder.Output","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/forbidden(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/forbidden(_:)","title":"Operations.GetOrder.Output.forbidden(_:)","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/forbidden(_:)","type":"topic","abstract":[{"text":"A requested resource cannot be accessed due to a lack of permission.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","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":"NotAccessable","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/Ok-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/Ok-swift.struct","title":"Operations.GetOrder.Output.Ok","type":"topic","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/ok-swift.struct","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetOrder","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder","type":"topic","role":"symbol","title":"Operations.GetOrder","kind":"symbol","abstract":[{"text":"Get an order for a seller in a marketplace.","type":"text"}],"navigatorTitle":[{"text":"GetOrder","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getorder"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/undocumented(statusCode:_:)":{"kind":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"undocumented"},{"kind":"text","text":"("},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","kind":"typeIdentifier","text":"UndocumentedPayload"},{"kind":"text","text":")"}],"title":"Operations.GetOrder.Output.undocumented(statusCode:_:)","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/undocumented(statuscode:_:)","abstract":[{"text":"Undocumented response.","type":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/undocumented(statusCode:_:)","role":"symbol"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/ok-swift.property":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/ok-swift.property","title":"ok","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/ok-swift.property","type":"topic","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"}],"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":"GetOrder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetOrderO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetOrderO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetOrderO6OutputO2OkV"}]},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/notFound(_:)":{"kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV","text":"NotFound","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"Operations.GetOrder.Output.notFound(_:)","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/notfound(_:)","type":"topic","abstract":[{"type":"text","text":"A requested resource cannot be found."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/notFound(_:)","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/unauthorized(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/unauthorized(_:)","title":"Operations.GetOrder.Output.unauthorized(_:)","type":"topic","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/unauthorized(_:)","abstract":[{"text":"A requested resource cannot be accessed due to a lack of authentication.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unauthorized","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":"Unauthorized","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO12UnauthorizedV","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/internalServerError":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"internalServerError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV","text":"InternalError","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/internalservererror","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".internalServerError"},{"type":"text","text":"."}],"title":"internalServerError","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/internalServerError"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/forbidden":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","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":"NotAccessable","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV","kind":"typeIdentifier"}],"title":"forbidden","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/forbidden","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is ","type":"text"},{"type":"codeVoice","code":".forbidden"},{"text":".","type":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/forbidden","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/ok(_:)":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetOrder","preciseIdentifier":"s:14DiscogsService10OperationsO8GetOrderO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO8GetOrderO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO8GetOrderO6OutputO2OkV"},{"kind":"text","text":")"}],"kind":"symbol","role":"symbol","title":"Operations.GetOrder.Output.ok(_:)","abstract":[{"text":"Successfully retrieved an order for a seller from a marketplace.","type":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/ok(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/ok(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/internalServerError(_:)":{"title":"Operations.GetOrder.Output.internalServerError(_:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/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"}],"kind":"symbol","abstract":[{"type":"text","text":"An Internal Server error was encountered."}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/internalservererror(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/notFound":{"kind":"symbol","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"}],"title":"notFound","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/notfound","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".notFound"},{"type":"text","text":"."}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/notFound","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/unauthorized":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unauthorized","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","kind":"typeIdentifier","text":"Responses"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO12UnauthorizedV","kind":"typeIdentifier","text":"Unauthorized"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".unauthorized"},{"type":"text","text":"."}],"title":"unauthorized","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/unauthorized","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/unauthorized"},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetOrder/Output/Equatable-Implementations":{"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetOrder\/Output\/Equatable-Implementations","role":"collectionGroup","title":"Equatable Implementations","kind":"article","type":"topic","url":"\/documentation\/discogsservice\/operations\/getorder\/output\/equatable-implementations"}}} |