File tree Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change 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 )
You can’t perform that action at this time.
0 commit comments