openapi: 3.1.0 info: title: <> version: "1.0.0" description: | <> ## Authentication | Route prefix | Auth | |---|---| | `/` | <> | | `/` | <> | ## Rate limiting | Endpoint категори | Limit | |---|---| | <> | <> | contact: email: <> url: <> license: name: Proprietary url: <> servers: - url: https://api.<>.com description: Production - url: https://sandbox.<>.com description: Sandbox tags: - name: <> description: <> - name: <> description: <> - name: health description: Health checks paths: ## ============================================== ## <> ## ============================================== /: post: tags: [<>] summary: <> description: | <> security: - <>: [] requestBody: required: true content: application/json: schema: type: object required: [<>] properties: <>: type: string example: "<>" <>: type: integer example: 0 responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/<>" "400": { $ref: "#/components/responses/BadRequest" } "401": { $ref: "#/components/responses/Unauthorized" } "404": { $ref: "#/components/responses/NotFound" } "429": { $ref: "#/components/responses/RateLimited" } //{id}: get: tags: [<>] summary: <> security: - <>: [] parameters: - in: path name: id required: true schema: { type: string, format: uuid } responses: "200": content: application/json: schema: $ref: "#/components/schemas/<>" ## ============================================== ## Health ## ============================================== /health: get: tags: [health] summary: Liveness probe responses: "200": description: OK /ready: get: tags: [health] summary: Readiness probe (DB + dependencies) /metrics: get: tags: [health] summary: Prometheus metrics components: securitySchemes: BearerAPIKey: type: http scheme: bearer description: | <> HMAC: type: apiKey description: | <> in: header name: X-Signature AdminJWT: type: http scheme: bearer bearerFormat: JWT description: | HS256 signed JWT. responses: BadRequest: description: Invalid input content: application/json: schema: $ref: "#/components/schemas/Error" Unauthorized: description: Authentication failed content: application/json: schema: $ref: "#/components/schemas/Error" Forbidden: description: Authenticated but not authorized NotFound: description: Resource not found RateLimited: description: Too many requests headers: Retry-After: schema: { type: integer } schemas: Error: type: object properties: code: { type: integer, example: 400 } message: { type: string } request_id: { type: string } <>: type: object properties: id: { type: string, format: uuid } name: { type: string } created_at: { type: string, format: date-time } updated_at: { type: string, format: date-time }