Files
javier eaee2b84f0 Documentation update (#17)
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>
2026-03-24 01:54:43 +00:00

1 line
18 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"kind":"symbol","sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/client\/editlisting(path:headers:body:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Update a listing in a marketplace."}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"editListing"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"EditListing","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO","text":"EditListing","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO","text":"RequestBodies","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO7ListingO","text":"Listing","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO","text":"EditListing","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO6OutputO","text":"Output","kind":"typeIdentifier"}],"externalID":"s:14DiscogsService11APIProtocolPAAE11editListing4path7headers4bodyAA10OperationsO04EditE0O6OutputOAK5InputV4PathV_AO7HeadersVAA10ComponentsO13RequestBodiesO0E0OtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","role":"symbol","extendedModule":"DiscogsService","symbolKind":"method","title":"editListing(path:headers:body:)","roleHeading":"Instance Method","modules":[{"name":"DiscogsService"}]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/editListing(path:headers:body:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"editListing"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO","text":"EditListing"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV","text":"Input"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing\/Input\/Path-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO","text":"EditListing"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV","text":"Input"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"body"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO","text":"RequestBodies"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies\/Listing","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO7ListingO","text":"Listing"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing","text":"EditListing","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing\/Output","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO6OutputO"}],"languages":["swift"],"platforms":["macOS"]}]},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"inlineContent":[{"text":"Edits the data associated with a listing in a marketplace.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"In case a status of a listing is not "},{"type":"codeVoice","code":"For Sale"},{"type":"text","text":", "},{"type":"codeVoice","code":"Draft"},{"type":"text","text":", or "},{"type":"codeVoice","code":"Expired"},{"type":"text","text":", it cannot be modified - only deleted. To re-list a Sold listing, a new listing must be created."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"This endpoint requires authentication as a listing owner."}],"type":"paragraph"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"POST \/marketplace\/listings\/{listing_id}"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","name":"Remark"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/marketplace\/listings\/{listing_id}\/post(editListing)"},{"text":".","type":"text"}]}],"type":"aside","name":"Remark"}],"kind":"content"}],"references":{"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"},"doc://DiscogsService/documentation/DiscogsService/Components/RequestBodies":{"url":"\/documentation\/discogsservice\/components\/requestbodies","navigatorTitle":[{"text":"RequestBodies","kind":"identifier"}],"abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/requestBodies"},{"type":"text","text":" section of the OpenAPI document."}],"title":"Components.RequestBodies","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RequestBodies","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/EditListing/Input":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/editlisting\/input","kind":"symbol","title":"Operations.EditListing.Input","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}]},"doc://DiscogsService/documentation/DiscogsService/Client/editListing(path:headers:body:)":{"type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"editListing","kind":"identifier"},{"kind":"text","text":"("},{"text":"path","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"EditListing","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV","kind":"typeIdentifier","text":"Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"EditListing","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV","text":"Input"},{"kind":"text","text":"."},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO5InputV7HeadersV"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"body"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO","text":"RequestBodies","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO7ListingO","text":"Listing","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO","text":"EditListing","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11EditListingO6OutputO","text":"Output","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/editListing(path:headers:body:)","abstract":[{"type":"text","text":"Update a listing in a marketplace."}],"title":"editListing(path:headers:body:)","url":"\/documentation\/discogsservice\/client\/editlisting(path:headers:body:)"},"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/EditListing":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EditListing","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing","type":"topic","role":"symbol","title":"Operations.EditListing","abstract":[{"text":"Update a listing in a marketplace.","type":"text"}],"kind":"symbol","navigatorTitle":[{"text":"EditListing","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/editlisting"},"doc://DiscogsService/documentation/DiscogsService/Operations/EditListing/Input/Path-swift.struct":{"abstract":[],"url":"\/documentation\/discogsservice\/operations\/editlisting\/input\/path-swift.struct","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing\/Input\/Path-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"navigatorTitle":[{"kind":"identifier","text":"Path"}],"role":"symbol","title":"Operations.EditListing.Input.Path","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/RequestBodies/Listing":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/requestbodies\/listing","kind":"symbol","title":"Components.RequestBodies.Listing","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Listing"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies\/Listing","navigatorTitle":[{"kind":"identifier","text":"Listing"}]},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"Wantlists","type":"text"}]},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"type":"text","text":" listings, and more."}],"title":"Client","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/EditListing/Input/Headers-swift.struct":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/editlisting\/input\/headers-swift.struct","kind":"symbol","title":"Operations.EditListing.Input.Headers","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing\/Input\/Headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}]},"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/EditListing/Output":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/EditListing\/Output","title":"Operations.EditListing.Output","url":"\/documentation\/discogsservice\/operations\/editlisting\/output","type":"topic","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}]}}}