rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
e6d05cb9cc88e10a82f72b10e11d103ecf35c36e
discogs-service/docs/data/documentation/discogsservice/components/schemas/release/companies.json
T
javier 428eedd89d Implemented the Services and Database GET endpoints (#2) 
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>
2025-10-09 23:51:39 +00:00

1 line
6.3 KiB
JSON
Raw Blame History

{"metadata":{"externalID":"s:14DiscogsService10ComponentsO7SchemasO7ReleaseV9companiesSayAE7LabelIdVGSgvp","roleHeading":"Instance Property","role":"symbol","modules":[{"name":"DiscogsService"}],"symbolKind":"property","title":"companies","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"companies"},{"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":"LabelId","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7LabelIdV"},{"kind":"text","text":"]?"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/release\/companies"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"companies"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"LabelId","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelId","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7LabelIdV"},{"kind":"text","text":"]?"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/components\/schemas\/Release\/companies","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note","name":"Remark"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release\/companies","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"A list of companies related to a release."}],"sections":[],"references":{"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/Schemas/Release":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/release","abstract":[{"type":"text","text":"A type that eepresents a particular physical or digital object released by one or more artists."}],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"Release","kind":"identifier"}],"title":"Components.Schemas.Release","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Release","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"type":"text","text":" section of the OpenAPI document."}],"role":"symbol","kind":"symbol","navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"title":"Components.Schemas","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Release/companies":{"abstract":[{"type":"text","text":"A list of companies related to a release."}],"role":"symbol","type":"topic","title":"companies","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"companies"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7LabelIdV","kind":"typeIdentifier","text":"LabelId"},{"kind":"text","text":"]?"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/release\/companies","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Release\/companies"},"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/Schemas/LabelId":{"navigatorTitle":[{"text":"LabelId","kind":"identifier"}],"abstract":[{"text":"A type that references a label.","type":"text"}],"role":"symbol","type":"topic","title":"Components.Schemas.LabelId","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"LabelId","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/labelid","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/LabelId"}}}
View Git Blame Copy Permalink