rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
8cf19e02c8f2311656e1e1a4e77d3390896192bd
discogs-service/docs/data/documentation/discogsservice/operations/getrelease/output/ok-swift.struct/headers-swift.struct.json
T
javier de5b4ff5d0 Implemented the missing Database endpoints (#8) 
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document.

Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation.

Reviewed-on: #8
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 15:20:20 +00:00

1 line
13 KiB
JSON
Raw Blame History

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