javier
428eedd89d
This PR contains the work done to include the define the information sections of the `OpenAPI` specification document and all the `GET` endpoints of the _Service_ and _Database_ categories.
The following endpoints have been defined in the document, and also tested manually with `Swift`:
* GET `/`
* GET `/artists/{artist_id}`
* GET `/artists/{artist_id}/releases`
* GET `/labels/{label_id}`
* GET `/labels/{label_id}/releases`
* GET `/masters/{master_id}`
* GET `/masters/{master_id}/versions`
* GET `/releases/{release_id}`
* GET `/releases/{release_id}/rating`
* GET `/releases/{release_id}/rating/{username}`
* GET `/releases/{release_id}/stats`
* GET `/database/search`
In addition, a first version of the _Github Pages_ documentation has been generated from the `DocC` documentation catalog, and the generated Swift code from the `openapi.yaml` file.
Reviewed-on: #2
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
7.1 KiB
JSON
1 line
7.1 KiB
JSON
{"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Input\/Headers-swift.struct\/accept","interfaceLanguage":"swift"},"metadata":{"symbolKind":"property","role":"symbol","externalID":"s:14DiscogsService10OperationsO9getArtistO5InputV7HeadersV6acceptSay14OpenAPIRuntime23AcceptHeaderContentTypeVyAE010AcceptablemN0OGGvp","title":"accept","modules":[{"name":"DiscogsService"}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"accept"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","text":"AcceptHeaderContentType"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO","text":"getArtist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO21AcceptableContentTypeO","text":"AcceptableContentType"},{"kind":"text","text":">]"}]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getartist\/input\/headers-swift.struct\/accept"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"accept"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","kind":"typeIdentifier","text":"AcceptHeaderContentType"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist","text":"getArtist"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO21AcceptableContentTypeO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/AcceptableContentType","text":"AcceptableContentType"},{"kind":"text","text":">]"}]}],"kind":"declarations"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Input\/Headers-swift.struct"]]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/AcceptableContentType":{"url":"\/documentation\/discogsservice\/operations\/getartist\/acceptablecontenttype","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/AcceptableContentType","kind":"symbol","role":"symbol","type":"topic","title":"Operations.getArtist.AcceptableContentType","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AcceptableContentType"}],"navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/Input/Headers-swift.struct":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Input\/Headers-swift.struct","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"title":"Operations.getArtist.Input.Headers","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartist\/input\/headers-swift.struct"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist":{"navigatorTitle":[{"kind":"identifier","text":"getArtist"}],"abstract":[{"type":"text","text":"Get information about an artist."}],"role":"symbol","type":"topic","title":"Operations.getArtist","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getArtist"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/Input":{"navigatorTitle":[{"text":"Input","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getartist\/input","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Input","abstract":[],"title":"Operations.getArtist.Input"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/discogsservice\/operations","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtist/Input/Headers-swift.struct/accept":{"url":"\/documentation\/discogsservice\/operations\/getartist\/input\/headers-swift.struct\/accept","type":"topic","title":"accept","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtist\/Input\/Headers-swift.struct\/accept","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accept","kind":"identifier"},{"text":": [","kind":"text"},{"text":"AcceptHeaderContentType","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV"},{"text":"<","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"getArtist","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO"},{"text":".","kind":"text"},{"text":"AcceptableContentType","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9getArtistO21AcceptableContentTypeO"},{"text":">]","kind":"text"}],"role":"symbol"}}} |