Skip to content

Commit 49e3eb7

Browse files
committed
Add backend/apps/api/rest/v0/README.md
1 parent da8597d commit 49e3eb7

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

backend/apps/api/rest/v0/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
# OWASP API v0
3+
4+
## Important points
5+
6+
When working on this API, **always follow these rules** to avoid breaking clients:
7+
8+
- The authentication class in `__init__.py` **must be named `ApiKey`**.
9+
- The client’s `api_key` parameter is automatically derived from this name.
10+
- **Do not rename this class**, only update its implementation if needed.
11+
12+
- Each API endpoint must have a **unique `operationId`** in the OpenAPI specification.
13+
- Duplicate `operationId`s will break client SDK generation and cause method conflicts.
14+
15+
- Endpoint naming documentation:
16+
- [Customize methods](https://www.speakeasy.com/docs/customize/methods)
17+
- [Customize namespaces](https://www.speakeasy.com/docs/customize/structure/namespaces)

0 commit comments

Comments
 (0)