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
8.2 KiB
JSON
1 line
8.2 KiB
JSON
{"sections":[],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"kind":"relationships","type":"conformsTo","title":"Conforms To"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound"]]},"topicSections":[{"generated":true,"title":"Enumeration Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum\/json(_:)"],"anchor":"Enumeration-Cases"},{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum\/json"],"anchor":"Instance-Properties"},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum\/Equatable-Implementations"],"anchor":"Default-Implementations"}],"metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"navigatorTitle":[{"text":"Body","kind":"identifier"}],"title":"Components.Responses.NotFound.Body","role":"symbol","roleHeading":"Enumeration","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV4BodyO","symbolKind":"enum"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"attribute","text":"@frozen"},{"kind":"text","text":" "},{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}]}]},{"kind":"content","content":[{"level":2,"text":"Overview","type":"heading","anchor":"overview"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/responses\/NotFound\/content","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","name":"Remark"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/responses\/notfound\/body-swift.enum"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Responses":{"url":"\/documentation\/discogsservice\/components\/responses","type":"topic","title":"Components.Responses","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/responses"},{"type":"text","text":" section of the OpenAPI document."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Responses"}],"role":"symbol","navigatorTitle":[{"text":"Responses","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/NotFound/Body-swift.enum":{"kind":"symbol","title":"Components.Responses.NotFound.Body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum","abstract":[],"url":"\/documentation\/discogsservice\/components\/responses\/notfound\/body-swift.enum","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Body"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Body"}]},"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/Responses/NotFound/Body-swift.enum/json":{"abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".json","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","type":"topic","title":"json","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"json","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"ServiceError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/responses\/notfound\/body-swift.enum\/json","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum\/json"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"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/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/NotFound/Body-swift.enum/Equatable-Implementations":{"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum\/Equatable-Implementations","title":"Equatable Implementations","role":"collectionGroup","kind":"article","abstract":[],"url":"\/documentation\/discogsservice\/components\/responses\/notfound\/body-swift.enum\/equatable-implementations"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/NotFound/Body-swift.enum/json(_:)":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"json"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"ServiceError","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B5ErrorV"},{"kind":"text","text":")"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound\/Body-swift.enum\/json(_:)","title":"Components.Responses.NotFound.Body.json(_:)","role":"symbol","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/responses\/notfound\/body-swift.enum\/json(_:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/NotFound":{"url":"\/documentation\/discogsservice\/components\/responses\/notfound","type":"topic","title":"Components.Responses.NotFound","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"NotFound","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"NotFound","kind":"identifier"}]}}} |