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