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 @@
{"abstract":[{"text":"A number of items to return per page.","type":"text"}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/parameters\/perpage"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"]]},"metadata":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"PerPage"}],"roleHeading":"Type Alias","navigatorTitle":[{"kind":"identifier","text":"PerPage"}],"role":"symbol","externalID":"s:14DiscogsService10ComponentsO10ParametersO7PerPagea","symbolKind":"typealias","modules":[{"name":"DiscogsService"}],"title":"Components.Parameters.PerPage"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"PerPage"},{"kind":"text","text":" = "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/components\/parameters\/PerPage","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","name":"Remark"}]}],"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/PerPage":{"abstract":[{"type":"text","text":"A number of items to return per page."}],"kind":"symbol","type":"topic","title":"Components.Parameters.PerPage","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage","url":"\/documentation\/discogsservice\/components\/parameters\/perpage","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PerPage","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"PerPage","kind":"identifier"}]},"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/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":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"}}}
{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PerPage","kind":"identifier"},{"text":" = ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"name":"Remark","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/parameters\/PerPage"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside"}]}],"metadata":{"symbolKind":"typealias","role":"symbol","externalID":"s:14DiscogsService10ComponentsO10ParametersO7PerPagea","roleHeading":"Type Alias","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PerPage","kind":"identifier"}],"navigatorTitle":[{"text":"PerPage","kind":"identifier"}],"title":"Components.Parameters.PerPage"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/components\/parameters\/perpage"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"]]},"abstract":[{"text":"A number of items to return per page.","type":"text"}],"references":{"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":{"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/Parameters/PerPage":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"PerPage","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"Components.Parameters.PerPage","type":"topic","url":"\/documentation\/discogsservice\/components\/parameters\/perpage","abstract":[{"type":"text","text":"A number of items to return per page."}],"navigatorTitle":[{"text":"PerPage","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage"},"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"}}}