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
12 KiB
JSON
1 line
12 KiB
JSON
{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getartistreleases\/output"]}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/Ok-swift.struct"],"anchor":"Structures","title":"Structures","generated":true},{"title":"Enumeration Cases","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/notFound(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/ok(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/undocumented(statusCode:_:)"],"anchor":"Enumeration-Cases"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/notFound","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/ok-swift.property"],"anchor":"Instance-Properties","title":"Instance Properties","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/Equatable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output","interfaceLanguage":"swift"},"metadata":{"title":"Operations.getArtistReleases.Output","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO17getArtistReleasesO6OutputO","symbolKind":"enum","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Output","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"roleHeading":"Enumeration"},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"@frozen","kind":"attribute"},{"text":" ","kind":"text"},{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]}]}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships","type":"conformsTo","title":"Conforms To"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output/notFound":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/notfound","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/notFound","kind":"symbol","title":"notFound","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".notFound"},{"type":"text","text":"."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV","text":"NotFound","kind":"typeIdentifier"}]},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"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/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output","abstract":[],"title":"Operations.getArtistReleases.Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases":{"navigatorTitle":[{"kind":"identifier","text":"getArtistReleases"}],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"getArtistReleases"}],"url":"\/documentation\/discogsservice\/operations\/getartistreleases","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases","abstract":[{"type":"text","text":"Get information about releases of an artist."}],"title":"Operations.getArtistReleases"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output/Ok-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Ok"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/ok-swift.struct","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/Ok-swift.struct","abstract":[],"title":"Operations.getArtistReleases.Output.Ok"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output/notFound(_:)":{"abstract":[{"type":"text","text":"A requested resource cannot be found."}],"role":"symbol","type":"topic","title":"Operations.getArtistReleases.Output.notFound(_:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"notFound"},{"kind":"text","text":"("},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","kind":"typeIdentifier","text":"Responses"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV","kind":"typeIdentifier","text":"NotFound"},{"kind":"text","text":")"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/notfound(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/notFound(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output/undocumented(statusCode:_:)":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/undocumented(statuscode:_:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/undocumented(statusCode:_:)","kind":"symbol","title":"Operations.getArtistReleases.Output.undocumented(statusCode:_:)","abstract":[{"text":"Undocumented response.","type":"text"}],"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"undocumented"},{"kind":"text","text":"("},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV"},{"kind":"text","text":")"}]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","kind":"symbol","role":"collection","type":"topic","title":"DiscogsService"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output/Equatable-Implementations":{"kind":"article","title":"Equatable Implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/Equatable-Implementations","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/equatable-implementations","abstract":[],"type":"topic","role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output/ok-swift.property":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/ok-swift.property","type":"topic","title":"ok","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO","text":"getArtistReleases","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is ","type":"text"},{"type":"codeVoice","code":".ok"},{"text":".","type":"text"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/ok-swift.property"},"doc://DiscogsService/documentation/DiscogsService/Operations/getArtistReleases/Output/ok(_:)":{"url":"\/documentation\/discogsservice\/operations\/getartistreleases\/output\/ok(_:)","type":"topic","title":"Operations.getArtistReleases.Output.ok(_:)","abstract":[{"type":"text","text":"A paginated list of releases of an artist."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/getArtistReleases\/Output\/ok(_:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"ok","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"getArtistReleases","preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO17getArtistReleasesO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol"}}} |