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
4.3 KiB
JSON
1 line
4.3 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Image"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}],"kind":"declarations"}],"sections":[],"metadata":{"externalID":"s:14DiscogsService10ComponentsO7SchemasO5ImageV4fromAGs7Decoder_p_tKcfc","role":"symbol","roleHeading":"Initializer","modules":[{"name":"DiscogsService"}],"symbolKind":"init","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Image\/init(from:)","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/image\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"type":"text","text":" section of the OpenAPI document."}],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"title":"Components.Schemas","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Image/init(from:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Image\/init(from:)","type":"topic","abstract":[],"url":"\/documentation\/discogsservice\/components\/schemas\/image\/init(from:)","role":"symbol","kind":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Image":{"url":"\/documentation\/discogsservice\/components\/schemas\/image","abstract":[{"type":"text","text":"A type that represents an image of a resource."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Image","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas.Image","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Image","kind":"identifier"}],"navigatorTitle":[{"text":"Image","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","url":"\/documentation\/discogsservice\/components","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"symbol","title":"Components","navigatorTitle":[{"text":"Components","kind":"identifier"}],"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"}}} |