Operations pillar · v0.16.0
api-endpoint ApiEndpoint
API-endpoint record.
$id · https://corpospec.com/schemas/v0.16.0/api-endpoint.schema.json
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| api_version | string | yes | API version (e.g. "v1", "2026-05-01"). |
| audience | ApiAudience | yes | Audience scope. |
| auth_required | AuthKind | yes | Authentication requirement. |
| id | PathRef | yes | Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$` |
| kind | ApiKind | yes | API kind / protocol. |
| method | HttpMethod | yes | HTTP method. |
| operation_id | string | yes | OpenAPI operation_id. |
| owner | PathRef | yes | Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$` |
| path | string | yes | URL path or operation key. |
| pii_class | PiiClass | yes | PII class of data crossed. |
| service | PathRef | yes | PathRef to the parent service. |
| status | ApiStatus | yes | Lifecycle. |
| deprecated_on | IsoDate? | — | First-deprecated date. |
| docs_ref | PathRef? | — | PathRef to docs / OpenAPI page. |
| p99_latency_target_ms | number? | — | SLO p99 latency target ms. |
| rate_limit_rpm | integer? | — | Rate limit (requests per minute; None = unlimited / inherited). |
| replaced_by | PathRef? | — | PathRef to replacement endpoint (when deprecated). |
| required_scopes | string[] | — | Scopes / permissions required. |
| schema_ref | PathRef? | — | PathRef to OpenAPI / GraphQL schema fragment. |
| sunset_on | IsoDate? | — | Date at which Sunset header begins (RFC 8594). |
Definitions
Shared types referenced within this schema.
ApiAudience
Audience scope.
ApiKind
API kind / protocol.
ApiStatus
Lifecycle.
AuthKind
Authentication requirement.
HttpMethod
HTTP method.
enum: "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"
IsoDate
ISO 8601 date (YYYY-MM-DD).
type: string
PathRef
Path-based cross-reference relative to .corpospec/ root.
Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
pattern: ^[a-z0-9_-]+(/[a-z0-9_.-]+)+$
PiiClass
Personal-data classification on every record carrying personal data, per
BDR 0070 / BDR 0069 / BDR 0078. Used by `corpospec-report` to gate
rendering and by the privacy pillar's RoPA records to determine
safeguards.
Reference in your YAML
# yaml-language-server: $schema=https://corpospec.com/schemas/v0.16.0/api-endpoint.schema.json