rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
bf12c9ee99ff62df25fca69a17a311fa95aae53d
discogs-service/docs/data/documentation/discogsservice/operations/getartist/output/ok-swift.struct.json
T
javier d01b60e6dd Added the Rate Limiting headers (#7) 
This PR contains the work done to define the `RateLimit`, `RateLimitRemaining` and the `RateLimitUsed` heades into the Open API specification document, as well as including these headers as part of the response for every existing endpoint declared in the mentioned document.

In addition, the `openapi-generator-config` files was also changed to have a different naming strategy.

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

1 line
12 KiB
JSON
Raw Blame History

{"metadata":{"role":"symbol","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"text":"Ok","kind":"identifier"}],"symbolKind":"struct","roleHeading":"Structure","title":"Operations.GetArtist.Output.Ok"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getartist\/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":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"platforms":["macOS"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output"]]},"topicSections":[{"anchor":"Structures","title":"Structures","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Headers-swift.struct"]},{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/init(headers:body:)"]},{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/body-swift.property","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/headers-swift.property"]},{"anchor":"Enumerations","title":"Enumerations","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Body-swift.enum"]},{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Equatable-Implementations"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/Headers-swift.struct":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/headers-swift.struct","abstract":[],"title":"Operations.GetArtist.Output.Ok.Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Headers-swift.struct","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist","abstract":[{"text":"Get information about an artist.","type":"text"}],"title":"Operations.GetArtist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetArtist","kind":"identifier"}],"navigatorTitle":[{"text":"GetArtist","kind":"identifier"}]},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/Body-swift.enum":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/body-swift.enum","abstract":[],"title":"Operations.GetArtist.Output.Ok.Body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Body-swift.enum","kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"navigatorTitle":[{"text":"Body","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/init(headers:body:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetArtist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"text":".","kind":"text"},{"text":"Body","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV4BodyO"},{"text":")","kind":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/init(headers:body:)","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/init(headers:body:)","kind":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Ok","type":"codeVoice"},{"text":".","type":"text"}],"title":"init(headers:body:)"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/body-swift.property":{"title":"body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/body-swift.property","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/body-swift.property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"body"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetArtist","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV4BodyO"}],"abstract":[{"type":"text","text":"Received HTTP response body"}],"kind":"symbol","role":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct","abstract":[],"title":"Operations.GetArtist.Output.Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"navigatorTitle":[{"text":"Ok","kind":"identifier"}]},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/output","abstract":[],"title":"Operations.GetArtist.Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output","kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations":{"kind":"symbol","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"type":"topic","url":"\/documentation\/discogsservice\/operations","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"title":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/Equatable-Implementations","type":"topic","kind":"article","url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/equatable-implementations","title":"Equatable Implementations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Output/Ok-swift.struct/headers-swift.property":{"title":"headers","abstract":[{"type":"text","text":"Received HTTP response headers"}],"url":"\/documentation\/discogsservice\/operations\/getartist\/output\/ok-swift.struct\/headers-swift.property","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Output\/Ok-swift.struct\/headers-swift.property","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO","text":"GetArtist","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO9GetArtistO6OutputO2OkV7HeadersV","text":"Headers","kind":"typeIdentifier"}],"type":"topic"}}}
View Git Blame Copy Permalink