Files
discogs-service/docs/data/documentation/discogsservice/client/searchdatabase(query:headers:).json
T
javier f3d5c0e6ac Implemented the User Wantlist endpoints (#13)
This PR contains the work done to implement the *User Wantlist* endpoints of the *Discogs API* online service in the `Open API` specification document:

* GET `/users/{username}/wants`
* POST `/users/{username}/wants/{release_id}`
* PUT `/users/{username}/wants/{release_id}`
* DELETE `/users/{username}/wants/{release_id}`

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

1 line
14 KiB
JSON

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