1 line
14 KiB
JSON
1 line
14 KiB
JSON
{"metadata":{"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"DiscogsService"}],"extendedModule":"DiscogsService","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"searchDatabase"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"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:)","externalID":"s:14DiscogsService11APIProtocolPAAE14searchDatabase5query7headersAA10OperationsO06SearchE0O6OutputOAJ5InputV5QueryV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","role":"symbol"},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"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","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO","text":"SearchDatabase","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Query-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO","text":"SearchDatabase","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO","text":"SearchDatabase","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO","text":"Output","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"content","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"},{"content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"code":"GET \/database\/search","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Remark","type":"aside"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/database\/search\/get(searchDatabase)"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark","style":"note"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/searchdatabase(query:headers:)"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/searchDatabase(query:headers:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Search any information from the database."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Output":{"kind":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"abstract":[],"title":"Operations.SearchDatabase.Output","url":"\/documentation\/discogsservice\/operations\/searchdatabase\/output","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","navigatorTitle":[{"kind":"identifier","text":"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"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"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"},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"Wantlists","type":"text"}]},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"type":"text","text":" listings, and more."}],"title":"Client","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Client/searchDatabase(query:headers:)":{"role":"symbol","url":"\/documentation\/discogsservice\/client\/searchdatabase(query:headers:)","kind":"symbol","title":"searchDatabase(query:headers:)","abstract":[{"text":"Search any information from the database.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"searchDatabase"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO","text":"SearchDatabase"},{"kind":"text","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"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/searchDatabase(query:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Input":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"Input","kind":"identifier"}],"role":"symbol","kind":"symbol","abstract":[],"title":"Operations.SearchDatabase.Input","url":"\/documentation\/discogsservice\/operations\/searchdatabase\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase":{"role":"symbol","url":"\/documentation\/discogsservice\/operations\/searchdatabase","kind":"symbol","title":"Operations.SearchDatabase","abstract":[{"text":"Search any information from the database.","type":"text"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SearchDatabase","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","navigatorTitle":[{"text":"SearchDatabase","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Input/Headers-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Headers-swift.struct","title":"Operations.SearchDatabase.Input.Headers","url":"\/documentation\/discogsservice\/operations\/searchdatabase\/input\/headers-swift.struct","type":"topic","abstract":[],"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/SearchDatabase/Input/Query-swift.struct":{"title":"Operations.SearchDatabase.Input.Query","type":"topic","url":"\/documentation\/discogsservice\/operations\/searchdatabase\/input\/query-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"navigatorTitle":[{"text":"Query","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Query-swift.struct","kind":"symbol","abstract":[],"role":"symbol"}}} |