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
3.3 KiB
JSON
1 line
3.3 KiB
JSON
{"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"symbolKind":"enum","navigatorTitle":[{"kind":"identifier","text":"Servers"}],"roleHeading":"Enumeration","title":"Servers","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"externalID":"s:14DiscogsService7ServersO","role":"symbol","modules":[{"name":"DiscogsService"}]},"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/servers"]}],"topicSections":[{"title":"Type Methods","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()"],"generated":true,"anchor":"Type-Methods"},{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"],"generated":true,"anchor":"Enumerations"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Servers","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"kind":"symbol","references":{"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/Servers/Server1":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1","navigatorTitle":[{"text":"Server1","kind":"identifier"}],"title":"Servers.Server1","role":"symbol","abstract":[{"type":"text","text":"Live Server"}],"kind":"symbol","url":"\/documentation\/discogsservice\/servers\/server1"},"doc://DiscogsService/documentation/DiscogsService/Servers/server1()":{"deprecated":true,"abstract":[{"type":"text","text":"Live Server"}],"title":"server1()","type":"topic","url":"\/documentation\/discogsservice\/servers\/server1()","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"server1"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()","role":"symbol","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Servers":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"title":"Servers","role":"symbol","abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"kind":"symbol","url":"\/documentation\/discogsservice\/servers"}}} |