rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
de5b4ff5d0506f8354e28ef31060eb09f754aece
discogs-service/docs/data/documentation/discogsservice/operations/getservice/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

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