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>
This commit was merged in pull request #8.
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
# ``APIProtocol``
|
||||
|
||||
## Topics
|
||||
|
||||
### Service endpoints
|
||||
|
||||
- ``APIProtocol/getService(_:)``
|
||||
- ``APIProtocol/getService(headers:)``
|
||||
|
||||
### Database endpoints
|
||||
|
||||
- ``APIProtocol/searchDatabase(_:)``
|
||||
- ``APIProtocol/searchDatabase(query:headers:)``
|
||||
- ``APIProtocol/getArtist(_:)``
|
||||
- ``APIProtocol/getArtist(path:headers:)``
|
||||
- ``APIProtocol/getArtistReleases(_:)``
|
||||
- ``APIProtocol/getArtistReleases(path:query:headers:)``
|
||||
- ``APIProtocol/getLabel(_:)``
|
||||
- ``APIProtocol/getLabel(path:headers:)``
|
||||
- ``APIProtocol/getLabelReleases(_:)``
|
||||
- ``APIProtocol/getLabelReleases(path:query:headers:)``
|
||||
- ``APIProtocol/getMaster(_:)``
|
||||
- ``APIProtocol/getMaster(path:headers:)``
|
||||
- ``APIProtocol/getMasterVersions(_:)``
|
||||
- ``APIProtocol/getMasterVersions(path:query:headers:)``
|
||||
- ``APIProtocol/getRelease(_:)``
|
||||
- ``APIProtocol/getRelease(path:query:headers:)``
|
||||
- ``APIProtocol/getReleaseRating(_:)``
|
||||
- ``APIProtocol/getReleaseRating(path:headers:)``
|
||||
- ``APIProtocol/getReleaseRatingByUser(_:)``
|
||||
- ``APIProtocol/getReleaseRatingByUser(path:headers:)``
|
||||
- ``APIProtocol/putReleaseRatingByUser(_:)``
|
||||
- ``APIProtocol/putReleaseRatingByUser(path:query:headers:)``
|
||||
- ``APIProtocol/deleteReleaseRatingByUser(_:)``
|
||||
- ``APIProtocol/deleteReleaseRatingByUser(path:headers:)``
|
||||
- ``APIProtocol/getReleaseStats(_:)``
|
||||
- ``APIProtocol/getReleaseStats(path:headers:)``
|
||||
@@ -0,0 +1,27 @@
|
||||
# ``Client``
|
||||
|
||||
## Topics
|
||||
|
||||
### Initializers
|
||||
|
||||
- ``Client/init(serverURL:configuration:transport:middlewares:)``
|
||||
|
||||
### Service endpoints
|
||||
|
||||
- ``Client/getService(_:)``
|
||||
|
||||
### Database endpoints
|
||||
|
||||
- ``Client/searchDatabase(_:)``
|
||||
- ``Client/getArtist(_:)``
|
||||
- ``Client/getArtistReleases(_:)``
|
||||
- ``Client/getLabel(_:)``
|
||||
- ``Client/getLabelReleases(_:)``
|
||||
- ``Client/getMaster(_:)``
|
||||
- ``Client/getMasterVersions(_:)``
|
||||
- ``Client/getRelease(_:)``
|
||||
- ``Client/getReleaseRating(_:)``
|
||||
- ``Client/getReleaseRatingByUser(_:)``
|
||||
- ``Client/putReleaseRatingByUser(_:)``
|
||||
- ``Client/deleteReleaseRatingByUser(_:)``
|
||||
- ``Client/getReleaseStats(_:)``
|
||||
Reference in New Issue
Block a user