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
17 KiB
JSON
1 line
17 KiB
JSON
{"schemaVersion":{"minor":3,"patch":0,"major":0},"relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"kind":"symbol","topicSections":[{"generated":true,"title":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload"],"anchor":"Structures"},{"generated":true,"title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/init(from:)"],"anchor":"Initializers"},{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/actor","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/from","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/message","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/new","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/order","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/original","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/refund","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/statusId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/subject","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/timestamp"],"anchor":"Instance-Properties"},{"generated":true,"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/CodingKeys"],"anchor":"Enumerations"},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/Equatable-Implementations"],"anchor":"Default-Implementations"}],"metadata":{"modules":[{"name":"DiscogsService"}],"roleHeading":"Structure","symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"OrderMessage"}],"navigatorTitle":[{"text":"OrderMessage","kind":"identifier"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO12OrderMessageV","role":"symbol","title":"Components.Schemas.OrderMessage"},"abstract":[{"type":"text","text":"A type that represents a message of an order."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"OrderMessage"}]}]},{"content":[{"type":"heading","text":"Overview","anchor":"overview","level":2},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/OrderMessage"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/ordermessage"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/new":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"new","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"text":"A new status identifier of an order, if any.","type":"text"}],"title":"new","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/new","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/new"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/original":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"original"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"?"}],"kind":"symbol","role":"symbol","type":"topic","title":"original","abstract":[{"type":"text","text":"An original status identifier of an order, if any."}],"url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/original","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/original"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/order":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"order","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7OrderIdV","text":"OrderId","kind":"typeIdentifier"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A reference to an order."}],"title":"order","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/order","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/order"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/Equatable-Implementations","kind":"article","role":"collectionGroup","type":"topic","title":"Equatable Implementations","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/equatable-implementations"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/RefundPayload":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refundpayload","navigatorTitle":[{"kind":"identifier","text":"RefundPayload"}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RefundPayload"}],"abstract":[{"text":"A requested refund for an order, if any.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload","title":"Components.Schemas.OrderMessage.RefundPayload"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable"},"doc://DiscogsService/Se":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/refund":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refund","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12OrderMessageV","text":"OrderMessage","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO12OrderMessageV13RefundPayloadV","text":"RefundPayload","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/refund","type":"topic","role":"symbol","title":"refund","abstract":[{"type":"text","text":"A requested refund for an order, if any."}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refund"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/actor":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"actor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"OrderMessageSender","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO18OrderMessageSenderV"},{"text":"?","kind":"text"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"text":"An actor that sent a message for an order, if any.","type":"text"}],"title":"actor","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/actor","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/actor"},"doc://DiscogsService/SE":{"identifier":"doc:\/\/DiscogsService\/SE","type":"unresolvable","title":"Swift.Encodable"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/timestamp":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/timestamp","kind":"symbol","role":"symbol","type":"topic","title":"timestamp","abstract":[{"type":"text","text":"A timestamp of a message for an order."}],"url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/timestamp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"timestamp","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/message":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A body of a message for an order."}],"title":"message","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/message","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/message"},"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/Components/Schemas/OrderMessage/statusId":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/statusId","kind":"symbol","role":"symbol","type":"topic","title":"statusId","abstract":[{"text":"An identifier for a status of an order, if any.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/statusid","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/init(from:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Creates a new instance by decoding from the given decoder."}],"title":"init(from:)","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/init(from:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/init(from:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Schemas"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/subject":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/subject","kind":"symbol","role":"symbol","type":"topic","title":"subject","abstract":[{"type":"text","text":"A subject of a message for an order."}],"url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/subject","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"subject"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/CodingKeys":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/CodingKeys","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"abstract":[],"title":"Components.Schemas.OrderMessage.CodingKeys","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/codingkeys"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"OrderMessage"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage","type":"topic","role":"symbol","title":"Components.Schemas.OrderMessage","abstract":[{"text":"A type that represents a message of an order.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"OrderMessage"}],"url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/from":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"from","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO18OrderMessageSenderV","text":"OrderMessageSender","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"A user that sent a message for an order, if any."}],"title":"from","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/from","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/from"},"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"}}} |