Skip to content

Commit 8cb34c9

Browse files
Fix API endpoint documentation from /api/v1/ to /api/v0/ (#2517)
- Update CONTRIBUTING.md to reference correct API endpoint - Update docs/contributing.md with correct endpoints and paths - Fix proxy/production.conf to route api/v0 instead of api/v1 - Correct endpoint paths from old structure to v0 API structure Fixes #2516
1 parent 1efdf25 commit 8cb34c9

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ Ensure that all `.env` files are saved in **UTF-8 format without BOM (Byte Order
281281
make run
282282
```
283283
284-
- Leave this terminal session running and wait until you see that [Nest local](http://localhost:8000/api/v1) is responding.
284+
- Leave this terminal session running and wait until you see that [Nest local](http://localhost:8000/api/v0) is responding.
285285
- Please note as we use containerized approach this command must be run in parallel to other Nest commands you may want to use. You need to keep it running in the current terminal and use another terminal session for your work.
286286
287287
1. **Load Initial Data**:
@@ -302,7 +302,7 @@ Ensure that all `.env` files are saved in **UTF-8 format without BOM (Byte Order
302302
303303
1. **Verify API Endpoints**:
304304
- Check the following endpoints availability:
305-
- [API](http://localhost:8000/api/v1/)
305+
- [API](http://localhost:8000/api/v0/)
306306
- [GraphQL](http://localhost:8000/graphql/)
307307
308308
### Optional Steps

docs/contributing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Before contributing, ensure you have the following installed:
131131
!!! note
132132
*Run this from the project root directory
133133
* Keep this terminal session running
134-
*Wait for [Nest local](http://localhost:8000/api/v1) to respond
134+
*Wait for [Nest local](http://localhost:8000/api/v0) to respond
135135
* Use separate terminal sessions for other commands
136136

137137
6. **Initialize Data**
@@ -145,9 +145,9 @@ Before contributing, ensure you have the following installed:
145145

146146
Check these endpoints:
147147
<br>
148-
> [Projects Endpoint](http://localhost:8000/api/v1/owasp/search/project)
148+
> [Projects Endpoint](http://localhost:8000/api/v0/projects/)
149149
<br>
150-
> [Issues Endpoint](http://localhost:8000/api/v1/owasp/search/issue)
150+
> [Issues Endpoint](http://localhost:8000/api/v0/issues/)
151151

152152
## Optional Setup
153153

proxy/production.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ server {
2727
proxy_set_header X-Real-IP $remote_addr;
2828
}
2929

30-
location ~ ^/(a|api/v1|csrf|graphql|idx|integrations|sitemap(?:\.xml)?|status)(/|$) {
30+
location ~ ^/(a|api/v0|csrf|graphql|idx|integrations|sitemap(?:\.xml)?|status)(/|$) {
3131
proxy_pass http://production-nest-backend:8000;
3232
proxy_set_header Host $host;
3333
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

0 commit comments

Comments
 (0)