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:
@@ -1 +1 @@
|
||||
{"kind":"symbol","abstract":[{"type":"text","text":"Contains URLs for pagination, compliant with RFC 5988."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"Link","kind":"identifier"},{"text":" = ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"It provides ","type":"text"},{"code":"first","type":"codeVoice"},{"type":"text","text":", "},{"code":"prev","type":"codeVoice"},{"text":", ","type":"text"},{"code":"next","type":"codeVoice"},{"type":"text","text":", and "},{"type":"codeVoice","code":"last"},{"type":"text","text":" links where applicable."}]},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/headers\/Link"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/Link"},"metadata":{"symbolKind":"typealias","title":"Components.Headers.Link","externalID":"s:14DiscogsService10ComponentsO7HeadersO4Linka","roleHeading":"Type Alias","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Link"}],"navigatorTitle":[{"kind":"identifier","text":"Link"}],"modules":[{"name":"DiscogsService"}],"role":"symbol"},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/headers\/link"]}],"references":{"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"},"doc://DiscogsService/documentation/DiscogsService/Components/Headers/Link":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Link"}],"navigatorTitle":[{"kind":"identifier","text":"Link"}],"title":"Components.Headers.Link","url":"\/documentation\/discogsservice\/components\/headers\/link","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/Link","abstract":[{"type":"text","text":"Contains URLs for pagination, compliant with RFC 5988."}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Headers":{"url":"\/documentation\/discogsservice\/components\/headers","title":"Components.Headers","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/headers","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"type":"topic"}}}
|
||||
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Link","kind":"identifier"},{"text":" = ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}]},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"It provides "},{"type":"codeVoice","code":"first"},{"type":"text","text":", "},{"type":"codeVoice","code":"prev"},{"type":"text","text":", "},{"type":"codeVoice","code":"next"},{"type":"text","text":", and "},{"type":"codeVoice","code":"last"},{"type":"text","text":" links where applicable."}]},{"style":"note","type":"aside","name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/components\/headers\/Link","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/discogsservice\/components\/headers\/link"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"typealias","role":"symbol","title":"Components.Headers.Link","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO7HeadersO4Linka","roleHeading":"Type Alias","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Link"}],"navigatorTitle":[{"text":"Link","kind":"identifier"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/Link"},"abstract":[{"type":"text","text":"Contains URLs for pagination, compliant with RFC 5988."}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Headers":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers","type":"topic","role":"symbol","title":"Components.Headers","kind":"symbol","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/headers"},{"type":"text","text":" section of the OpenAPI document."}],"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"url":"\/documentation\/discogsservice\/components\/headers"},"doc://DiscogsService/documentation/DiscogsService/Components/Headers/Link":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Link"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Link"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Contains URLs for pagination, compliant with RFC 5988."}],"title":"Components.Headers.Link","url":"\/documentation\/discogsservice\/components\/headers\/link","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/Link"},"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":{"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."}]}}}
|
||||
Reference in New Issue
Block a user