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

{"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships"}],"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"overview","text":"Overview","level":2,"type":"heading"},{"name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/GET\/responses\/200\/headers"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","type":"aside"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO03GetB0O6OutputO2OkV7HeadersV","title":"Operations.GetService.Output.Ok.Headers"},"topicSections":[{"generated":true,"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/init(xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)"]},{"generated":true,"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimit","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitRemaining","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitUsed"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/Equatable-Implementations"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getservice\/output\/ok-swift.struct\/headers-swift.struct"]}],"references":{"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/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Output/Ok-swift.struct/Headers-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct","kind":"symbol","role":"symbol","type":"topic","title":"Operations.GetService.Output.Ok.Headers","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getservice\/output\/ok-swift.struct\/headers-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Output":{"type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}],"kind":"symbol","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output","title":"Operations.GetService.Output","url":"\/documentation\/discogsservice\/operations\/getservice\/output"},"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/GetService/Output/Ok-swift.struct/Headers-swift.struct/init(xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/init(xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)","kind":"symbol","role":"symbol","type":"topic","title":"init(xDiscogsRateLimit:xDiscogsRateLimitUsed:xDiscogsRateLimitRemaining:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Headers","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/discogsservice\/operations\/getservice\/output\/ok-swift.struct\/headers-swift.struct\/init(xdiscogsratelimit:xdiscogsratelimitused:xdiscogsratelimitremaining:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"xDiscogsRateLimit"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO","text":"Headers"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO9RateLimita","text":"RateLimit"},{"kind":"text","text":", "},{"kind":"externalParam","text":"xDiscogsRateLimitUsed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO","text":"Headers"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO13RateLimitUseda","text":"RateLimitUsed"},{"kind":"text","text":", "},{"kind":"externalParam","text":"xDiscogsRateLimitRemaining"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO","text":"Headers"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO18RateLimitRemaininga","text":"RateLimitRemaining"},{"kind":"text","text":")"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Output/Ok-swift.struct/Headers-swift.struct/xDiscogsRateLimitUsed":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"xDiscogsRateLimitUsed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO13RateLimitUseda","kind":"typeIdentifier","text":"RateLimitUsed"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitUsed","abstract":[{"type":"text","text":"A number of requests that have been made in an existing rate limit window."}],"url":"\/documentation\/discogsservice\/operations\/getservice\/output\/ok-swift.struct\/headers-swift.struct\/xdiscogsratelimitused","title":"xDiscogsRateLimitUsed"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Output/Ok-swift.struct/Headers-swift.struct/xDiscogsRateLimitRemaining":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimitRemaining","kind":"symbol","role":"symbol","type":"topic","title":"xDiscogsRateLimitRemaining","abstract":[{"type":"text","text":"A number of remaining requests that can be made in an existing rate limit window."}],"url":"\/documentation\/discogsservice\/operations\/getservice\/output\/ok-swift.struct\/headers-swift.struct\/xdiscogsratelimitremaining","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"xDiscogsRateLimitRemaining","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO"},{"text":".","kind":"text"},{"text":"RateLimitRemaining","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO18RateLimitRemaininga"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Output/Ok-swift.struct/Headers-swift.struct/Equatable-Implementations":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/Equatable-Implementations","title":"Equatable Implementations","url":"\/documentation\/discogsservice\/operations\/getservice\/output\/ok-swift.struct\/headers-swift.struct\/equatable-implementations","type":"topic","abstract":[],"kind":"article","role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService","title":"Operations.GetService","url":"\/documentation\/discogsservice\/operations\/getservice","type":"topic","abstract":[{"type":"text","text":"Get information about the service."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetService"}],"navigatorTitle":[{"kind":"identifier","text":"GetService"}]},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Output/Ok-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct","kind":"symbol","role":"symbol","type":"topic","title":"Operations.GetService.Output.Ok","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getservice\/output\/ok-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService/Output/Ok-swift.struct/Headers-swift.struct/xDiscogsRateLimit":{"url":"\/documentation\/discogsservice\/operations\/getservice\/output\/ok-swift.struct\/headers-swift.struct\/xdiscogsratelimit","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService\/Output\/Ok-swift.struct\/Headers-swift.struct\/xDiscogsRateLimit","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"xDiscogsRateLimit"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"RateLimit","preciseIdentifier":"s:14DiscogsService10ComponentsO7HeadersO9RateLimita"}],"abstract":[{"text":"A total number of requests that can be made in a minute window.","type":"text"}],"title":"xDiscogsRateLimit","type":"topic","kind":"symbol"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable"}}}