rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
4511a6e49c0437ebb1a73cf777cb9f84542c4bcd
discogs-service/docs/data/documentation/discogsservice/operations/searchdatabase/input/query-swift.struct/perpage.json
T
javier de5b4ff5d0 Implemented the missing Database endpoints (#8) 
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document.

Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation.

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

1 line
8.3 KiB
JSON
Raw Blame History

{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/searchdatabase\/input\/query-swift.struct\/perpage"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"perPage","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO7PerPagea","text":"PerPage","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/database\/search\/GET\/query\/per_page"},{"text":".","type":"text"}]}],"type":"aside","name":"Remark","style":"note"}]}],"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"perPage","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO7PerPagea","text":"PerPage","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"perPage","role":"symbol","externalID":"s:14DiscogsService10OperationsO14SearchDatabaseO5InputV5QueryV7perPageSiSgvp","roleHeading":"Instance Property","modules":[{"name":"DiscogsService"}],"symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Query-swift.struct"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","abstract":[{"type":"text","text":"A number of items to return per page."}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Query-swift.struct\/perPage","interfaceLanguage":"swift"},"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"SearchDatabase","kind":"identifier"}],"title":"Operations.SearchDatabase","navigatorTitle":[{"kind":"identifier","text":"SearchDatabase"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","kind":"symbol","abstract":[{"type":"text","text":"Search any information from the database."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Input/Query-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase\/input\/query-swift.struct","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"title":"Operations.SearchDatabase.Input.Query","navigatorTitle":[{"text":"Query","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Query-swift.struct","abstract":[],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"navigatorTitle":[{"text":"Components","kind":"identifier"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/PerPage":{"type":"topic","title":"Components.Parameters.PerPage","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage","abstract":[{"type":"text","text":"A number of items to return per page."}],"navigatorTitle":[{"text":"PerPage","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/perpage","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PerPage","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Input/Query-swift.struct/perPage":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input\/Query-swift.struct\/perPage","title":"perPage","type":"topic","abstract":[{"text":"A number of items to return per page.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"perPage","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO7PerPagea","text":"PerPage","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/discogsservice\/operations\/searchdatabase\/input\/query-swift.struct\/perpage","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Input":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase\/input","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"title":"Operations.SearchDatabase.Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Input","abstract":[],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","title":"Operations","type":"topic","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/discogsservice\/operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Parameters","kind":"identifier"}],"navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"title":"Components.Parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","url":"\/documentation\/discogsservice\/components\/parameters","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/parameters","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}]}}}
View Git Blame Copy Permalink