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.5 KiB
JSON
1 line
4.5 KiB
JSON
{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/CodingKeys"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/pagination\/codingkeys\/pages"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/CodingKeys\/pages"},"metadata":{"role":"symbol","title":"Components.Schemas.Pagination.CodingKeys.pages","roleHeading":"Case","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pages","kind":"identifier"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO10PaginationV10CodingKeysO5pagesyA2ImF","symbolKind":"case","modules":[{"name":"DiscogsService"}]},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pages","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/CodingKeys/pages":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pages","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/codingkeys\/pages","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/CodingKeys\/pages","title":"Components.Schemas.Pagination.CodingKeys.pages","kind":"symbol","role":"symbol","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Pagination/CodingKeys":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination\/CodingKeys","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/pagination\/codingkeys","abstract":[],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.Pagination.CodingKeys","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}]},"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":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"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/Components/Schemas/Pagination":{"navigatorTitle":[{"kind":"identifier","text":"Pagination"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Pagination"}],"url":"\/documentation\/discogsservice\/components\/schemas\/pagination","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Pagination","abstract":[{"type":"text","text":"A type that provides details about a paginated result."}],"title":"Components.Schemas.Pagination"}}} |