rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
d01b60e6dd16d15055a60dc75ebeac2da9e134f4
discogs-service/docs/data/documentation/discogsservice/components/schemas/artist.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
20 KiB
JSON
Raw Blame History

{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"sections":[],"abstract":[{"type":"text","text":"A type that represents an artist or a group."}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/artist"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Artist"}],"modules":[{"name":"DiscogsService"}],"symbolKind":"struct","role":"symbol","navigatorTitle":[{"text":"Artist","kind":"identifier"}],"roleHeading":"Structure","externalID":"s:14DiscogsService10ComponentsO7SchemasO6ArtistV","title":"Components.Schemas.Artist"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Artist"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"text":"Overview","anchor":"overview","type":"heading","level":2},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/Artist"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/init(id:name:realname:resourceUrl:uri:releasesUrl:profile:urls:namevariations:members:images:dataQuality:)"],"anchor":"Initializers","generated":true},{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/dataQuality","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/images","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/members","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/name","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/namevariations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/profile","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/realname","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/releasesUrl","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/resourceUrl","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/uri","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/urls"]},{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/CodingKeys"],"anchor":"Enumerations","generated":true},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/urls":{"role":"symbol","abstract":[{"type":"text","text":"A list of URLs related to an artist, if any."}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/urls","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"urls","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/urls","title":"urls"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/members":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/members","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/members","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"members"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO8ArtistIdV","kind":"typeIdentifier","text":"ArtistId"},{"kind":"text","text":"]?"}],"title":"members","abstract":[{"type":"text","text":"A list of artists related to an artist (in case of group), if any."}],"role":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/namevariations":{"kind":"symbol","abstract":[{"type":"text","text":"A list of name variations related to an artist, if any."}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/namevariations","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"namevariations","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"title":"namevariations","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/namevariations"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/uri":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"uri"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"uri","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/uri","abstract":[{"type":"text","text":"A URI representation of an artist."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/uri"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"url":"\/documentation\/discogsservice\/components\/schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"kind":"symbol","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Schemas"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/CodingKeys":{"url":"\/documentation\/discogsservice\/components\/schemas\/artist\/codingkeys","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/CodingKeys","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"kind":"symbol","title":"Components.Schemas.Artist.CodingKeys","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/name":{"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/name","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/name","role":"symbol","abstract":[{"type":"text","text":"A name of an artist."}],"type":"topic","title":"name"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/images":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/images","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"images"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO5ImageV","text":"Image"},{"kind":"text","text":"]?"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/images","title":"images","abstract":[{"text":"A list of images related to an artist, if any.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/profile":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/profile","role":"symbol","abstract":[{"text":"A detailed profile of an artist, if any.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"profile","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"profile","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/profile","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist":{"url":"\/documentation\/discogsservice\/components\/schemas\/artist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Artist"}],"kind":"symbol","title":"Components.Schemas.Artist","abstract":[{"text":"A type that represents an artist or a group.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Artist"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/releasesUrl":{"role":"symbol","abstract":[{"text":"A URL to the releases of an artist.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas\/artist\/releasesurl","kind":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"releasesUrl","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/releasesUrl","title":"releasesUrl"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/init(from:)":{"kind":"symbol","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/init(from:)","type":"topic","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"title":"init(from:)","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/init(from:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/resourceUrl":{"url":"\/documentation\/discogsservice\/components\/schemas\/artist\/resourceurl","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/resourceUrl","role":"symbol","kind":"symbol","title":"resourceUrl","abstract":[{"text":"A URI resource of an artist.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resourceUrl","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/Equatable-Implementations","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/equatable-implementations","role":"collectionGroup","type":"topic","abstract":[],"title":"Equatable Implementations"},"doc://DiscogsService/documentation/DiscogsService/Components":{"url":"\/documentation\/discogsservice\/components","title":"Components","role":"symbol","abstract":[{"type":"text","text":"Types generated from the components section of the OpenAPI document."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","navigatorTitle":[{"kind":"identifier","text":"Components"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/id":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/id","url":"\/documentation\/discogsservice\/components\/schemas\/artist\/id","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"abstract":[{"text":"An identifier of an artist.","type":"text"}],"title":"id","role":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/realname":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/realname","abstract":[{"text":"A real name of an artist, if any.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"realname"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/discogsservice\/components\/schemas\/artist\/realname","title":"realname"},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://DiscogsService/SE":{"identifier":"doc:\/\/DiscogsService\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/dataQuality":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"dataQuality","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"dataQuality","type":"topic","abstract":[{"type":"text","text":"An explanation for the data quality related to an artist."}],"url":"\/documentation\/discogsservice\/components\/schemas\/artist\/dataquality","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/dataQuality"},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Artist/init(id:name:realname:resourceUrl:uri:releasesUrl:profile:urls:namevariations:members:images:dataQuality:)":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Artist\/init(id:name:realname:resourceUrl:uri:releasesUrl:profile:urls:namevariations:members:images:dataQuality:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Artist"},{"type":"text","text":"."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realname"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"resourceUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"uri"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"releasesUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"urls"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"namevariations"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"members"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"ArtistId","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO8ArtistIdV"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"images"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Image","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO5ImageV"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"dataQuality"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"url":"\/documentation\/discogsservice\/components\/schemas\/artist\/init(id:name:realname:resourceurl:uri:releasesurl:profile:urls:namevariations:members:images:dataquality:)","title":"init(id:name:realname:resourceUrl:uri:releasesUrl:profile:urls:namevariations:members:images:dataQuality:)"}}}
View Git Blame Copy Permalink