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
10 KiB
JSON
1 line
10 KiB
JSON
{"variants":[{"paths":["\/documentation\/discogsservice\/client\/getreleaseratingbyuser(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getReleaseRatingByUser(_:)","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"DiscogsService"}],"symbolKind":"method","role":"symbol","roleHeading":"Instance Method","externalID":"s:14DiscogsService6ClientV22getReleaseRatingByUseryAA10OperationsOADO6OutputOAG5InputVYaKF","title":"getReleaseRatingByUser(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getReleaseRatingByUser","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO5InputV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO6OutputO","kind":"typeIdentifier"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getReleaseRatingByUser","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getReleaseRatingByUser","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRatingByUser\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO5InputV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getReleaseRatingByUser","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO6OutputO","text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRatingByUser\/Output"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"inlineContent":[{"type":"text","text":"Retrieves the rating for a given release by a specific user."}],"type":"paragraph"},{"type":"aside","name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/releases\/{release_id}\/rating\/{username}"},{"type":"text","text":"."}]}]},{"type":"aside","name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/releases\/{release_id}\/rating\/{username}\/get(getReleaseRatingByUser)"},{"type":"text","text":"."}]}]}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"abstract":[{"type":"text","text":"Get information about a rating of release by a user."}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"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/getReleaseRatingByUser/Output":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRatingByUser\/Output","type":"topic","url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/output","abstract":[],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.getReleaseRatingByUser.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseRatingByUser/Input":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRatingByUser\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.getReleaseRatingByUser.Input","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input"},"doc://DiscogsService/documentation/DiscogsService/Client/getReleaseRatingByUser(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getReleaseRatingByUser(_:)","type":"topic","url":"\/documentation\/discogsservice\/client\/getreleaseratingbyuser(_:)","abstract":[{"type":"text","text":"Get information about a rating of release by a user."}],"role":"symbol","kind":"symbol","title":"getReleaseRatingByUser(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getReleaseRatingByUser"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO22getReleaseRatingByUserO6OutputO"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/getReleaseRatingByUser":{"navigatorTitle":[{"text":"getReleaseRatingByUser","kind":"identifier"}],"abstract":[{"type":"text","text":"Get information about a rating of release by a user."}],"role":"symbol","type":"topic","title":"Operations.getReleaseRatingByUser","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getReleaseRatingByUser","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getReleaseRatingByUser"},"doc://DiscogsService/documentation/DiscogsService/Client":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"title":"Client","role":"symbol","abstract":[{"type":"text","text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as "},{"type":"emphasis","inlineContent":[{"text":"Artists","type":"text"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"text":"Releases","type":"text"}]},{"type":"text","text":", and "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Labels"}]},{"type":"text","text":". Your application can also manage "},{"type":"emphasis","inlineContent":[{"type":"text","text":"User Collections"}]},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"Wantlists","type":"text"}]},{"text":", create ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"text":" listings, and more.","type":"text"}],"kind":"symbol","url":"\/documentation\/discogsservice\/client"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"}}} |