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>
This commit was merged in pull request #17.
This commit is contained in:
2026-03-24 01:54:43 +00:00
committed by Javier Cicchelli
parent b14a9fa816
commit eaee2b84f0
12656 changed files with 12970 additions and 12928 deletions
@@ -1 +1 @@
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InventoryStatus"]]},"sections":[],"metadata":{"externalID":"s:14DiscogsService10ComponentsO10ParametersO15InventoryStatusO5draftyA2GmF","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"draft","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"symbolKind":"case","role":"symbol","title":"Components.Parameters.InventoryStatus.draft","roleHeading":"Case"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"draft"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InventoryStatus\/draft","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/parameters\/inventorystatus\/draft"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"title":"Components.Parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Parameters"}],"navigatorTitle":[{"kind":"identifier","text":"Parameters"}],"url":"\/documentation\/discogsservice\/components\/parameters","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/parameters"},{"text":" section of the OpenAPI document.","type":"text"}],"role":"symbol","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/InventoryStatus":{"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"InventoryStatus"}],"abstract":[{"type":"text","text":"A status of a inventory."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InventoryStatus","title":"Components.Parameters.InventoryStatus","url":"\/documentation\/discogsservice\/components\/parameters\/inventorystatus","role":"symbol","navigatorTitle":[{"text":"InventoryStatus","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/InventoryStatus/draft":{"abstract":[],"kind":"symbol","type":"topic","title":"Components.Parameters.InventoryStatus.draft","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InventoryStatus\/draft","url":"\/documentation\/discogsservice\/components\/parameters\/inventorystatus\/draft","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"draft","kind":"identifier"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Components"}],"navigatorTitle":[{"text":"Components","kind":"identifier"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"kind":"symbol"}}}
{"metadata":{"modules":[{"name":"DiscogsService"}],"role":"symbol","roleHeading":"Case","title":"Components.Parameters.InventoryStatus.draft","symbolKind":"case","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"draft"}],"externalID":"s:14DiscogsService10ComponentsO10ParametersO15InventoryStatusO5draftyA2GmF"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InventoryStatus"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"draft","kind":"identifier"}]}]}],"kind":"symbol","variants":[{"paths":["\/documentation\/discogsservice\/components\/parameters\/inventorystatus\/draft"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InventoryStatus\/draft"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Parameters","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/parameters"},{"type":"text","text":" section of the OpenAPI document."}],"title":"Components.Parameters","url":"\/documentation\/discogsservice\/components\/parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"},"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/Parameters/InventoryStatus/draft":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"draft","kind":"identifier"}],"kind":"symbol","role":"symbol","type":"topic","abstract":[],"title":"Components.Parameters.InventoryStatus.draft","url":"\/documentation\/discogsservice\/components\/parameters\/inventorystatus\/draft","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InventoryStatus\/draft"},"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/Parameters/InventoryStatus":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/InventoryStatus","abstract":[{"type":"text","text":"A status of an inventory."}],"type":"topic","title":"Components.Parameters.InventoryStatus","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"InventoryStatus","kind":"identifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/inventorystatus","navigatorTitle":[{"text":"InventoryStatus","kind":"identifier"}]}}}