de5b4ff5d0
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>
1 line
8.2 KiB
JSON
1 line
8.2 KiB
JSON
{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable\/Body-swift.enum"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV","kind":"typeIdentifier","text":"ServiceError"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" }"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"style":"note","type":"aside","name":"Throws","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is not "},{"type":"codeVoice","code":".json"},{"type":"text","text":"."}]}]},{"style":"note","type":"aside","name":"See Also","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":".json"},{"type":"text","text":"."}]}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable\/Body-swift.enum\/json"},"kind":"symbol","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".json"},{"type":"text","text":"."}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV","kind":"typeIdentifier","text":"ServiceError"}],"externalID":"s:14DiscogsService10ComponentsO9ResponsesO11UnavailableV4BodyO4jsonAC7SchemasO0B5ErrorVvp","modules":[{"name":"DiscogsService"}],"title":"json","symbolKind":"property","roleHeading":"Instance Property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/responses\/unavailable\/body-swift.enum\/json"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"type":"topic","title":"Components.Schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"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/Components/Responses/Unavailable":{"type":"topic","title":"Components.Responses.Unavailable","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable","abstract":[],"navigatorTitle":[{"text":"Unavailable","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/responses\/unavailable","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Unavailable","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses":{"type":"topic","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/responses"},{"type":"text","text":" section of the OpenAPI document."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","title":"Components.Responses","navigatorTitle":[{"kind":"identifier","text":"Responses"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/responses","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Responses"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/Unavailable/Body-swift.enum":{"type":"topic","title":"Components.Responses.Unavailable.Body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable\/Body-swift.enum","abstract":[],"navigatorTitle":[{"text":"Body","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/responses\/unavailable\/body-swift.enum","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/Unavailable/Body-swift.enum/json":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"json","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"ServiceError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV"}],"type":"topic","title":"json","url":"\/documentation\/discogsservice\/components\/responses\/unavailable\/body-swift.enum\/json","role":"symbol","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"type":"codeVoice","code":".json"},{"text":".","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/Unavailable\/Body-swift.enum\/json"},"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/Schemas/ServiceError":{"type":"topic","abstract":[{"type":"text","text":"A type that contains any error data."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ServiceError","title":"Components.Schemas.ServiceError","navigatorTitle":[{"kind":"identifier","text":"ServiceError"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/serviceerror","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ServiceError"}]}}} |