Files
discogs-service/docs/data/documentation/discogsservice/client/searchdatabase(query:headers:).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
14 KiB
JSON

{"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"metadata":{"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:14DiscogsService11APIProtocolPAAE14searchDatabase5query7headersAA10OperationsO06SearchE0O6OutputOAJ5InputV5QueryV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","modules":[{"name":"DiscogsService"}],"role":"symbol","extendedModule":"DiscogsService","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"searchDatabase","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO","text":"SearchDatabase","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO","text":"SearchDatabase","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO","text":"SearchDatabase","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO","text":"Output","kind":"typeIdentifier"}],"title":"searchDatabase(query:headers:)"},"abstract":[{"type":"text","text":"Search any information from the database."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"searchDatabase"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","kind":"typeIdentifier","text":"SearchDatabase","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Query-swift.struct","kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV5QueryV"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","kind":"typeIdentifier","text":"SearchDatabase","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Headers-swift.struct","kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV7HeadersV"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","kind":"typeIdentifier","text":"SearchDatabase","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output","kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"Issue a search query to the Discogs database."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"This endpoint supports pagination and also, it requires authentication."}],"type":"paragraph"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/database\/search"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/database\/search\/get(searchDatabase)"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/searchdatabase(query:headers:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/searchDatabase(query:headers:)"},"references":{"doc://DiscogsService/documentation/DiscogsService/Client/searchDatabase(query:headers:)":{"role":"symbol","abstract":[{"type":"text","text":"Search any information from the database."}],"kind":"symbol","type":"topic","url":"\/documentation\/discogsservice\/client\/searchdatabase(query:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"searchDatabase","kind":"identifier"},{"text":"(","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"SearchDatabase","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"SearchDatabase","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"SearchDatabase","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO","kind":"typeIdentifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/searchDatabase(query:headers:)","title":"searchDatabase(query:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Input":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","title":"Operations.SearchDatabase.Input","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"SearchDatabase"}],"kind":"symbol","title":"Operations.SearchDatabase","abstract":[{"type":"text","text":"Search any information from the database."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"SearchDatabase"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Input/Query-swift.struct":{"title":"Operations.SearchDatabase.Input.Query","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/searchdatabase\/input\/query-swift.struct","role":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Query-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Input/Headers-swift.struct":{"title":"Operations.SearchDatabase.Input.Headers","url":"\/documentation\/discogsservice\/operations\/searchdatabase\/input\/headers-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Headers-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"abstract":[],"kind":"symbol","role":"symbol","type":"topic"},"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/SearchDatabase/Output":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","title":"Operations.SearchDatabase.Output","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Output","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Client"}],"kind":"symbol","title":"Client","abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"inlineContent":[{"type":"text","text":"Artists"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"type":"text","text":"Releases"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"type":"text","text":"Wantlists"}],"type":"emphasis"},{"text":", create ","type":"text"},{"inlineContent":[{"type":"text","text":"Marketplace"}],"type":"emphasis"},{"text":" listings, and more.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}}