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 @@
{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys\/year"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:14DiscogsService10ComponentsO7SchemasO12SearchResultV10CodingKeysO4yearyA2ImF","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"year","kind":"identifier"}],"roleHeading":"Case","title":"Components.Schemas.SearchResult.CodingKeys.year","modules":[{"name":"DiscogsService"}],"symbolKind":"case"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"year"}],"platforms":["macOS"],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys\/year","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/CodingKeys/year":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"year"}],"title":"Components.Schemas.SearchResult.CodingKeys.year","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys\/year","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys\/year","abstract":[],"kind":"symbol"},"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"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"url":"\/documentation\/discogsservice\/components\/schemas","title":"Components.Schemas","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Schemas"}],"navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/CodingKeys":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"title":"Components.Schemas.SearchResult.CodingKeys","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys","abstract":[],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SearchResult"}],"navigatorTitle":[{"kind":"identifier","text":"SearchResult"}],"title":"Components.Schemas.SearchResult","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult","abstract":[{"type":"text","text":"A type that represents a search result."}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"}}}
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"year"}],"platforms":["macOS"],"languages":["swift"]}]}],"metadata":{"symbolKind":"case","role":"symbol","modules":[{"name":"DiscogsService"}],"roleHeading":"Case","externalID":"s:14DiscogsService10ComponentsO7SchemasO12SearchResultV10CodingKeysO4yearyA2ImF","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"year"}],"title":"Components.Schemas.SearchResult.CodingKeys.year"},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys\/year"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys\/year"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys"]]},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/CodingKeys":{"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys","kind":"symbol","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys","abstract":[],"type":"topic","title":"Components.Schemas.SearchResult.CodingKeys"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SearchResult"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult","type":"topic","role":"symbol","title":"Components.Schemas.SearchResult","abstract":[{"text":"A type that represents a search result.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"SearchResult"}],"url":"\/documentation\/discogsservice\/components\/schemas\/searchresult"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/SearchResult/CodingKeys/year":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/SearchResult\/CodingKeys\/year","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"year","kind":"identifier"}],"abstract":[],"title":"Components.Schemas.SearchResult.CodingKeys.year","url":"\/documentation\/discogsservice\/components\/schemas\/searchresult\/codingkeys\/year","type":"topic"},"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":{"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":{"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"}}}