19 lines
843 B
Markdown
19 lines
843 B
Markdown
|
# API definitions
|
||
|
|
|
||
|
|
- **OpenAPI:** [openapi.yaml](openapi.yaml) — REST API for resolve, bulk-resolve, admin, system.
|
||
|
|
- **Route directive schema:** [route-directive.schema.json](route-directive.schema.json) — JSON Schema for RouteDirective and ResolveResponse.
|
||
|
|
- **Protobuf:** [proto/resolver.proto](proto/resolver.proto) — Resolver service and messages (ResolveRequest, ResolveResponse, RouteDirective). Package `as411.resolver.v1`.
|
||
|
|
|
||
|
|
## Generating stubs from Proto
|
||
|
|
|
||
|
|
From the repo root, with `protoc` installed:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Example (adjust paths for your language)
|
||
|
|
protoc -I docs/api/proto docs/api/proto/resolver.proto --go_out=paths=source_relative:.
|
||
|
|
# Or with buf (if using buf.gen.yaml):
|
||
|
|
# buf generate docs/api/proto
|
||
|
|
```
|
||
|
|
|
||
|
|
gRPC server implementation is optional; the Proto file defines the contract for clients and future gRPC support.
|