rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
4511a6e49c0437ebb1a73cf777cb9f84542c4bcd
discogs-service/docs/data/documentation/discogsservice/operations.json
T
javier de5b4ff5d0 Implemented the missing Database endpoints (#8) 
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document.

Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation.

Reviewed-on: #8
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 15:20:20 +00:00

1 line
13 KiB
JSON
Raw Blame History

{"seeAlsoSections":[{"title":"Types","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"],"generated":true,"anchor":"Types"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase"],"generated":true,"anchor":"Enumerations"}],"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","interfaceLanguage":"swift"},"metadata":{"title":"Operations","modules":[{"name":"DiscogsService"}],"symbolKind":"enum","externalID":"s:14DiscogsService10OperationsO","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"roleHeading":"Enumeration","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}]},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/operations"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser":{"type":"topic","abstract":[{"type":"text","text":"Update information about a rating of release by a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","title":"Operations.PutReleaseRatingByUser","navigatorTitle":[{"kind":"identifier","text":"PutReleaseRatingByUser"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PutReleaseRatingByUser"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabel":{"type":"topic","title":"Operations.GetLabel","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabel","abstract":[{"text":"Get information about a label","type":"text"}],"navigatorTitle":[{"text":"GetLabel","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getlabel","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetLabel","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtistReleases":{"role":"symbol","title":"Operations.GetArtistReleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtistReleases","type":"topic","abstract":[{"text":"Get information about releases of an artist.","type":"text"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetArtistReleases","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getartistreleases","navigatorTitle":[{"kind":"identifier","text":"GetArtistReleases"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetArtist","kind":"identifier"}],"type":"topic","title":"Operations.GetArtist","url":"\/documentation\/discogsservice\/operations\/getartist","role":"symbol","abstract":[{"text":"Get information about an artist.","type":"text"}],"kind":"symbol","navigatorTitle":[{"text":"GetArtist","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist"},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"navigatorTitle":[{"text":"Components","kind":"identifier"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Servers":{"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"title":"Servers","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/servers","role":"symbol","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMaster":{"type":"topic","title":"Operations.GetMaster","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster","abstract":[{"text":"Get information about a master release.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"GetMaster"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getmaster","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetMaster"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRating":{"abstract":[{"type":"text","text":"Get information about a rating of release."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetReleaseRating","kind":"identifier"}],"title":"Operations.GetReleaseRating","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleaserating","role":"symbol","navigatorTitle":[{"text":"GetReleaseRating","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRating"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetLabelReleases","kind":"identifier"}],"title":"Operations.GetLabelReleases","navigatorTitle":[{"kind":"identifier","text":"GetLabelReleases"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases","kind":"symbol","abstract":[{"type":"text","text":"Get information about the releases of a label."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetReleaseRatingByUser","kind":"identifier"}],"navigatorTitle":[{"text":"GetReleaseRatingByUser","kind":"identifier"}],"title":"Operations.GetReleaseRatingByUser","url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","abstract":[{"type":"text","text":"Get information about a rating of release by a user."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetService":{"type":"topic","abstract":[{"type":"text","text":"Get information about the service."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetService","title":"Operations.GetService","navigatorTitle":[{"kind":"identifier","text":"GetService"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getservice","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetService"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease":{"type":"topic","title":"Operations.GetRelease","abstract":[{"text":"Get information about a release","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease","navigatorTitle":[{"text":"GetRelease","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getrelease","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetRelease"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetMasterVersions","kind":"identifier"}],"title":"Operations.GetMasterVersions","navigatorTitle":[{"text":"GetMasterVersions","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","kind":"symbol","abstract":[{"type":"text","text":"Get information about the versions of a master release."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetReleaseStats","kind":"identifier"}],"title":"Operations.GetReleaseStats","navigatorTitle":[{"text":"GetReleaseStats","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats","abstract":[{"type":"text","text":"Get information about statistics of release."}],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser":{"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"DeleteReleaseRatingByUser"}],"title":"Operations.DeleteReleaseRatingByUser","navigatorTitle":[{"kind":"identifier","text":"DeleteReleaseRatingByUser"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser","abstract":[{"type":"text","text":"Delete information about a rating of release by a user."}],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"SearchDatabase","kind":"identifier"}],"title":"Operations.SearchDatabase","navigatorTitle":[{"kind":"identifier","text":"SearchDatabase"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","kind":"symbol","abstract":[{"type":"text","text":"Search any information from the database."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","title":"Operations","type":"topic","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/discogsservice\/operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}]}}}
View Git Blame Copy Permalink