Skip to content

Commit 712c9ba

Browse files
committed
API: /reference -> /docs
More standard URL path Signed-off-by: kingbri <8082010+kingbri1@users.noreply.github.com>
1 parent a7e5769 commit 712c9ba

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ Then follow these steps:
7272
5. Start YALS:
7373
1. Windows: Double click `YALS.exe` or run `.\YALS.exe` from the terminal (recommended)
7474
2. macOS/Linux: Open a terminal and run `./YALS`
75+
6. Navigate to `http://<your URL>/docs` (ex. `http://localhost:5000/docs`) to view the YALS Scalar API documentation.
7576
## Features
7677

7778
- OpenAI compatible API

api/server.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export function createApi() {
4242
);
4343

4444
app.get(
45-
"/reference",
45+
"/docs",
4646
apiReference({
4747
spec: {
4848
url: "/openapi.json",

0 commit comments

Comments
 (0)