Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
funkwhale
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Zwordi
funkwhale
Commits
7b03ddbb
Verified
Commit
7b03ddbb
authored
6 years ago
by
Eliot Berriot
Browse files
Options
Downloads
Patches
Plain Diff
Fix #224 and #226: changelog and documentation
parent
a8baf8fa
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
changes/changelog.d/224.enhancement
+30
-0
30 additions, 0 deletions
changes/changelog.d/224.enhancement
changes/changelog.d/226.bugfix
+1
-0
1 addition, 0 deletions
changes/changelog.d/226.bugfix
dev.yml
+1
-1
1 addition, 1 deletion
dev.yml
docs/swagger.yml
+8
-8
8 additions, 8 deletions
docs/swagger.yml
with
40 additions
and
9 deletions
changes/changelog.d/224.enhancement
0 → 100644
+
30
−
0
View file @
7b03ddbb
Retructured music API to increase performance and remove useless endpoints (#224)
Music API changes
^^^^^^^^^^^^^^^^^
This release includes an API break. Even though the API is advertised
as unstable, and not documented, here is a brief explanation of the change in
case you are using the API in a client or in a script. Summary of the changes:
- ``/api/v1/artists`` does not includes a list of tracks anymore. It was to heavy
to return all of this data all the time. You can get all tracks for an
artist using ``/api/v1/tracks?artist=artist_id``
- Additionally, ``/api/v1/tracks`` now support an ``album`` filter to filter
tracks matching an album
- ``/api/v1/artists/search``, ``/api/v1/albums/search`` and ``/api/v1/tracks/search``
endpoints are removed. Use ``/api/v1/{artists|albums|tracks}/?q=yourquery``
instead. It's also more powerful, since you can combine search with other
filters and ordering options.
- ``/api/v1/requests/import-requests/search`` endpoint is removed as well.
Use ``/api/v1/requests/import-requests/?q=yourquery``
instead. It's also more powerful, since you can combine search with other
filters and ordering options.
Of course, the front-end was updated to work with the new API, so this should
not impact end-users in any way, apart from slight performance gains.
.. note::
The API is still not stable and may evolve again in the future. API freeze
will come at a later point.
This diff is collapsed.
Click to expand it.
changes/changelog.d/226.bugfix
0 → 100644
+
1
−
0
View file @
7b03ddbb
Empty save button in radio builder (#226)
This diff is collapsed.
Click to expand it.
dev.yml
+
1
−
1
View file @
7b03ddbb
...
...
@@ -130,7 +130,7 @@ services:
ports
:
-
'
8002:8080'
volumes
:
-
"
./
api/
docs/swagger.yml:/usr/share/nginx/html/swagger.yml"
-
"
./docs/swagger.yml:/usr/share/nginx/html/swagger.yml"
networks
:
internal
:
...
...
This diff is collapsed.
Click to expand it.
docs/swagger.yml
+
8
−
8
View file @
7b03ddbb
...
...
@@ -78,7 +78,7 @@ paths:
results
:
type
:
"
array"
items
:
$ref
:
"
#/definitions/Artist
Nested
"
$ref
:
"
#/definitions/Artist
WithAlbums
"
properties
:
resultsCount
:
...
...
@@ -106,7 +106,7 @@ definitions:
creation_date
:
type
:
"
string"
format
:
"
date-time"
Artist
Nested
:
Artist
WithAlbums
:
type
:
"
object"
allOf
:
-
$ref
:
"
#/definitions/Artist"
...
...
@@ -115,7 +115,7 @@ definitions:
albums
:
type
:
"
array"
items
:
$ref
:
"
#/definitions/A
lbumNested
"
$ref
:
"
#/definitions/A
rtistAlbum
"
Album
:
type
:
"
object"
...
...
@@ -143,16 +143,16 @@ definitions:
format
:
"
date"
example
:
"
2001-01-01"
A
lbumNested
:
A
rtistAlbum
:
type
:
"
object"
allOf
:
-
$ref
:
"
#/definitions/Album"
-
type
:
"
object"
properties
:
tracks
:
type
:
"
array
"
items
:
$ref
:
"
#/definitions/Track"
tracks
_count
:
type
:
"
integer
"
format
:
"
int64"
example
:
16
Track
:
type
:
"
object"
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment