Files
javier eaee2b84f0 Documentation update (#17)
This PR contains the work done to update the overall documentation of the package.

Reviewed-on: #17
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2026-03-24 01:54:43 +00:00

1 line
7.2 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"SearchDatabase","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO2OkV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output\/Ok-swift.struct"},{"text":")","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/database\/search\/get(searchDatabase)\/responses\/200","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark","style":"note"},{"type":"paragraph","inlineContent":[{"text":"HTTP response code: ","type":"text"},{"type":"codeVoice","code":"200 ok"},{"text":".","type":"text"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output\/ok(_:)"},"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Successfully retrieved search results.","type":"text"}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/searchdatabase\/output\/ok(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"Operations.SearchDatabase.Output.ok(_:)","symbolKind":"case","roleHeading":"Case","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"SearchDatabase","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO"},{"kind":"text","text":"."},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO2OkV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO2okyA2G2OkVcAGmF"},"references":{"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/Output/Ok-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase\/output\/ok-swift.struct","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output\/Ok-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.SearchDatabase.Output.Ok"},"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":{"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/ok(_:)":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output\/ok(_:)","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"SearchDatabase","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO2OkV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[{"type":"text","text":"Successfully retrieved search results."}],"title":"Operations.SearchDatabase.Output.ok(_:)","type":"topic","url":"\/documentation\/discogsservice\/operations\/searchdatabase\/output\/ok(_:)"},"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"}}}