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
7.8 KiB
JSON

{"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetInventory","kind":"identifier"}]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Overview","anchor":"overview","level":2,"type":"heading"},{"inlineContent":[{"text":"Returns the list of listings for an inventory of a user.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"Basic information about each listing and the corresponding release is provided, suitable for display in a list. For detailed information about the release, make another API call to fetch the corresponding Release."}],"type":"paragraph"},{"inlineContent":[{"text":"This endpoint accepts pagination and also, in case of authenticated as an inventory owner, items that not only have the ","type":"text"},{"code":"For Sale","type":"codeVoice"},{"type":"text","text":" state will be shown as well as other extra fields in those items such as "},{"code":"weight","type":"codeVoice"},{"type":"text","text":", "},{"code":"format_quality","type":"codeVoice"},{"type":"text","text":", "},{"code":"external_id","type":"codeVoice"},{"type":"text","text":", "},{"code":"location","type":"codeVoice"},{"type":"text","text":", and "},{"code":"quantity_keys","type":"codeVoice"},{"type":"text","text":". Note that the "},{"code":"quantity","type":"codeVoice"},{"type":"text","text":" field is read-only for "},{"type":"emphasis","inlineContent":[{"type":"text","text":"NearMint"}]},{"type":"text","text":" users, who will see "},{"type":"emphasis","inlineContent":[{"text":"1","type":"text"}]},{"type":"text","text":" for all quantity values, regardless of their actual count."}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"type":"text","text":"In case the user is authorized, the listing will contain a "},{"type":"codeVoice","code":"in_cart"},{"type":"text","text":" boolean field indicating whether or not this listing is in their cart."}]},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/users\/{username}\/inventory","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Remark"},{"type":"aside","style":"note","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/inventory\/get(getInventory)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Remark"}]}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/Input"],"generated":true,"title":"Structures","anchor":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/id"],"generated":true,"title":"Type Properties","anchor":"Type-Properties"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/Output"],"anchor":"Enumerations","title":"Enumerations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getinventory"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Get the listings in an inventory of a seller.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"kind":"symbol","metadata":{"roleHeading":"Enumeration","title":"Operations.GetInventory","externalID":"s:14DiscogsService10OperationsO12GetInventoryO","symbolKind":"enum","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetInventory","kind":"identifier"}],"navigatorTitle":[{"text":"GetInventory","kind":"identifier"}],"role":"symbol","modules":[{"name":"DiscogsService"}]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetInventory/AcceptableContentType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AcceptableContentType"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"role":"symbol","kind":"symbol","abstract":[],"title":"Operations.GetInventory.AcceptableContentType","url":"\/documentation\/discogsservice\/operations\/getinventory\/acceptablecontenttype","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/AcceptableContentType"},"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/GetInventory":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetInventory"}],"navigatorTitle":[{"text":"GetInventory","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory","abstract":[{"type":"text","text":"Get the listings in an inventory of a seller."}],"url":"\/documentation\/discogsservice\/operations\/getinventory","title":"Operations.GetInventory"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetInventory/id":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/id","type":"topic","role":"symbol","title":"id","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getinventory\/id"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetInventory/Input":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/Input","type":"topic","role":"symbol","title":"Operations.GetInventory.Input","abstract":[],"kind":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getinventory\/input"},"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/GetInventory/Output":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetInventory\/Output","kind":"symbol","role":"symbol","type":"topic","title":"Operations.GetInventory.Output","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getinventory\/output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]}}}