mirror of
https://github.com/azaion/gps-denied-onboard.git
synced 2026-04-22 11:36:37 +00:00
Update README to reflect changes in test infrastructure organization and task decomposition workflow. Remove obsolete E2E test templates and clarify input specifications for integration tests. Enhance documentation for planning and implementation phases, including new directory structures and task management processes.
This commit is contained in:
@@ -0,0 +1,15 @@
|
||||
---
|
||||
description: "OpenAPI/Swagger API documentation standards — applied when editing API spec files"
|
||||
globs: ["**/openapi*", "**/swagger*"]
|
||||
alwaysApply: false
|
||||
---
|
||||
# OpenAPI
|
||||
|
||||
- Use OpenAPI 3.0+ specification
|
||||
- Define reusable schemas in `components/schemas`; reference with `$ref`
|
||||
- Include `description` for every endpoint, parameter, and schema property
|
||||
- Define `responses` for at least 200, 400, 401, 404, 500
|
||||
- Use `tags` to group endpoints by domain
|
||||
- Include `examples` for request/response bodies
|
||||
- Version the API in the path (`/api/v1/`) or via header
|
||||
- Use `operationId` for code generation compatibility
|
||||
Reference in New Issue
Block a user