Move docs endpoint to /api-docs

CHANGELOG.md

@@ -43,7 +43,7 @@
 ### API
 
 - API version is now 8.0.
-- Documentation is now served under `/docs` instead of `/swagger` (eg. `http://localhost:5050/docs`)
+- Documentation is now served under `/api-docs` instead of `/swagger` (eg. `http://localhost:5050/api-docs`)
 - Clients are now expected to send their preferred API major version in a `Accept-Version` header. Omitting this currently defaults to `7`, but will become an error in future Polaris releases. Support for API version 7 will be removed entirely in a future release.
 - Most API responses now support gzip compression.
 - The response format of the `/browse`, `/flatten`, `/get_playlist`, `/search/<query>` endpoints has been modified to accomodate large lists.

README.md

@@ -40,7 +40,7 @@ Password: `demo_password`
 
 ### API Documentation
 
-The Polaris server API is documented via [OpenAPI](https://demo.polaris.stream/docs/). Every installation of Polaris distributes this interactive documentation. To access it, simply open http://localhost:5050/docs/ in your browser on the machine running Polaris.
+The Polaris server API is documented via [OpenAPI](https://demo.polaris.stream/api-docs/). Every installation of Polaris distributes this interactive documentation. To access it, simply open http://localhost:5050/api-docs/ in your browser on the machine running Polaris.
 
 ## Credits & License Information
 

src/server/axum.rs

@@ -31,7 +31,7 @@ pub fn make_router(app: App) -> NormalizePath<Router> {
 
 	let router = open_api_router
 		.with_state(app.clone())
-		.merge(Scalar::with_url("/docs", open_api))
+		.merge(Scalar::with_url("/api-docs", open_api))
 		.fallback_service(static_files)
 		.layer(logger::LogLayer::new());
 

src/server/test/protocol.rs

@@ -35,7 +35,7 @@ pub fn web_index() -> Request<()> {
 pub fn docs_index() -> Request<()> {
 	Request::builder()
 		.method(Method::GET)
-		.uri("/docs")
+		.uri("/api-docs")
 		.body(())
 		.unwrap()
 }