d01b60e6dd
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>
1 line
14 KiB
JSON
1 line
14 KiB
JSON
{"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/pagination"]}],"kind":"symbol","topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/UrlsPayload"],"generated":true,"anchor":"Structures","title":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/init(from:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/init(page:pages:perPage:items:urls:)"],"generated":true,"anchor":"Initializers","title":"Initializers"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/items","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/page","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/pages","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/perPage","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urls"],"generated":true,"anchor":"Instance-Properties","title":"Instance Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/CodingKeys"],"generated":true,"anchor":"Enumerations","title":"Enumerations"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations","title":"Default Implementations"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Pagination","kind":"identifier"}],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"text":"Overview","anchor":"overview","type":"heading"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/schemas\/Pagination","type":"codeVoice"},{"type":"text","text":"."}]}],"style":"note","name":"Remark","type":"aside"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"abstract":[{"text":"A type that provides details about a paginated result.","type":"text"}],"metadata":{"symbolKind":"struct","navigatorTitle":[{"kind":"identifier","text":"Pagination"}],"roleHeading":"Structure","externalID":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Pagination","kind":"identifier"}],"role":"symbol","title":"Components.Schemas.Pagination","modules":[{"name":"DiscogsService"}]},"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/page":{"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/page","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"page","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"title":"page","abstract":[{"type":"text","text":"A number for the current page in a result."}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/page"},"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":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/Equatable-Implementations":{"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/Equatable-Implementations","kind":"article","title":"Equatable Implementations","abstract":[],"role":"collectionGroup","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/equatable-implementations"},"doc://DiscogsService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/perPage":{"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/perPage","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"perPage"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"title":"perPage","abstract":[{"type":"text","text":"A total number of items per page in a result."}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/perpage"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/CodingKeys":{"title":"Components.Schemas.Pagination.CodingKeys","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/CodingKeys","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/codingkeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"abstract":[],"kind":"symbol","role":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/urls":{"title":"urls","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"urls"},{"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:14DiscogsService10ComponentsO7SchemasO10PaginationV","text":"Pagination"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV11UrlsPayloadV","text":"UrlsPayload"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urls","role":"symbol","abstract":[{"type":"text","text":"A collection of URLs to navigate through the pages in a result."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/urls"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/pages":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/pages","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pages","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/pages","role":"symbol","title":"pages","abstract":[{"type":"text","text":"A total number of pages in a result."}]},"doc://DiscogsService/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SE"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/items":{"title":"items","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/items","role":"symbol","abstract":[{"type":"text","text":"A total number of items in a result."}],"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"items"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/items","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/init(from:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/init(from:)","title":"init(from:)","role":"symbol","abstract":[],"type":"topic","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/init(from:)","kind":"symbol"},"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/Pagination":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Pagination"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Pagination"}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/pagination","abstract":[{"type":"text","text":"A type that provides details about a paginated result."}],"kind":"symbol","title":"Components.Schemas.Pagination"},"doc://DiscogsService/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/init(page:pages:perPage:items:urls:)":{"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/init(page:pages:perpage:items:urls:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/init(page:pages:perPage:items:urls:)","role":"symbol","kind":"symbol","title":"init(page:pages:perPage:items:urls:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"Pagination","type":"codeVoice"},{"type":"text","text":"."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"page"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"pages"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"perPage"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"items"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"urls"},{"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:14DiscogsService10ComponentsO7SchemasO10PaginationV","kind":"typeIdentifier","text":"Pagination"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV11UrlsPayloadV","kind":"typeIdentifier","text":"UrlsPayload"},{"kind":"text","text":")"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/UrlsPayload":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/UrlsPayload","type":"topic","navigatorTitle":[{"text":"UrlsPayload","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UrlsPayload","kind":"identifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/urlspayload","abstract":[{"text":"A collection of URLs to navigate through the pages in a result.","type":"text"}],"kind":"symbol","title":"Components.Schemas.Pagination.UrlsPayload"}}} |