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
13 KiB
JSON
1 line
13 KiB
JSON
{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/parameters"]}],"topicSections":[{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ArtistId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Country","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Currency","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Format","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Label","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/LabelId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/MasterId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Page","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Released","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Username"],"anchor":"Type-Aliases","title":"Type Aliases"},{"generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ArtistReleasesSort","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/MasterVersionsSort","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/SortOrder"],"anchor":"Enumerations","title":"Enumerations"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/parameters","type":"codeVoice"},{"type":"text","text":" section of the OpenAPI document."}],"metadata":{"modules":[{"name":"DiscogsService"}],"title":"Components.Parameters","externalID":"s:14DiscogsService10ComponentsO10ParametersO","symbolKind":"enum","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Parameters","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"roleHeading":"Enumeration"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Parameters","kind":"identifier"}],"platforms":["macOS"]}],"kind":"declarations"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/ReleaseId":{"navigatorTitle":[{"text":"ReleaseId","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseId","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/parameters\/releaseid","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId","abstract":[{"type":"text","text":"An identifier of a release."}],"title":"Components.Parameters.ReleaseId"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/MasterId":{"navigatorTitle":[{"text":"MasterId","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MasterId","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/parameters\/masterid","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/MasterId","title":"Components.Parameters.MasterId","kind":"symbol","role":"symbol","abstract":[{"text":"An identifier of a master.","type":"text"}],"type":"topic"},"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/Parameters/LabelId":{"kind":"symbol","title":"Components.Parameters.LabelId","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/LabelId","abstract":[{"type":"text","text":"An identifier of a label."}],"url":"\/documentation\/discogsservice\/components\/parameters\/labelid","type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"LabelId","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"LabelId","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/ArtistReleasesSort":{"role":"symbol","type":"topic","abstract":[{"text":"A value to sort the releases of an artist by.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ArtistReleasesSort","title":"Components.Parameters.ArtistReleasesSort","url":"\/documentation\/discogsservice\/components\/parameters\/artistreleasessort","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ArtistReleasesSort"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"ArtistReleasesSort"}]},"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/Parameters/MasterVersionsSort":{"navigatorTitle":[{"text":"MasterVersionsSort","kind":"identifier"}],"abstract":[{"type":"text","text":"A value to sort the master versions by."}],"role":"symbol","type":"topic","title":"Components.Parameters.MasterVersionsSort","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MasterVersionsSort","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/masterversionssort","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/MasterVersionsSort"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/SortOrder":{"navigatorTitle":[{"text":"SortOrder","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SortOrder","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/parameters\/sortorder","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/SortOrder","title":"Components.Parameters.SortOrder","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The order to sort the results."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/ArtistId":{"navigatorTitle":[{"text":"ArtistId","kind":"identifier"}],"abstract":[{"type":"text","text":"An identifier of an artist."}],"title":"Components.Parameters.ArtistId","role":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/artistid","type":"topic","kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ArtistId","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ArtistId"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/PerPage":{"type":"topic","url":"\/documentation\/discogsservice\/components\/parameters\/perpage","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/PerPage","kind":"symbol","title":"Components.Parameters.PerPage","navigatorTitle":[{"kind":"identifier","text":"PerPage"}],"abstract":[{"type":"text","text":"A number of items to return per page."}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PerPage","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Currency":{"navigatorTitle":[{"kind":"identifier","text":"Currency"}],"abstract":[{"text":"A currency code in the marketplace.","type":"text"}],"title":"Components.Parameters.Currency","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/components\/parameters\/currency","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Currency"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Currency"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Country":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Country"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Country","navigatorTitle":[{"kind":"identifier","text":"Country"}],"title":"Components.Parameters.Country","role":"symbol","abstract":[{"type":"text","text":"A filter by country."}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/country"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Label":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Label"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Label","navigatorTitle":[{"kind":"identifier","text":"Label"}],"title":"Components.Parameters.Label","role":"symbol","abstract":[{"type":"text","text":"A filter by label."}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/label"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Username":{"kind":"symbol","title":"Components.Parameters.Username","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Username","abstract":[{"type":"text","text":"A username of a user."}],"url":"\/documentation\/discogsservice\/components\/parameters\/username","type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Username","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"Username","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/parameters"},{"type":"text","text":" section of the OpenAPI document."}],"role":"symbol","type":"topic","title":"Components.Parameters","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Parameters","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Page":{"url":"\/documentation\/discogsservice\/components\/parameters\/page","type":"topic","title":"Components.Parameters.Page","abstract":[{"text":"A number of page of results to return.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Page","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Page"}],"role":"symbol","navigatorTitle":[{"text":"Page","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Released":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Released"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Released","navigatorTitle":[{"kind":"identifier","text":"Released"}],"title":"Components.Parameters.Released","role":"symbol","abstract":[{"type":"text","text":"A filter by release year."}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/parameters\/released"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Format":{"navigatorTitle":[{"text":"Format","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"Format","kind":"identifier"}],"url":"\/documentation\/discogsservice\/components\/parameters\/format","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Format","abstract":[{"type":"text","text":"A filter by format."}],"title":"Components.Parameters.Format"}}} |