Orbiplex API Descriptor¶
Source schema: doc/schemas/orbiplex.api-descriptor.v1.schema.json
Descriptor contributed by a daemon route registry or middleware component for aggregated OpenAPI projection. It is descriptive, not authoritative.
Fields¶
| Field | Required | Shape | Description |
|---|---|---|---|
schema |
yes |
const: orbiplex.api-descriptor.v1 |
|
component/id |
yes |
string | |
base/path |
no |
ref: #/$defs/pathTemplate |
|
endpoints |
yes |
array |
Definitions¶
| Definition | Shape | Description |
|---|---|---|
endpoint |
object | |
pathParam |
object | |
schemaBinding |
object | |
pathTemplate |
string | |
| ## Field Semantics |
schema¶
- Required:
yes - Shape: const:
orbiplex.api-descriptor.v1
component/id¶
- Required:
yes - Shape: string
base/path¶
- Required:
no - Shape: ref:
#/$defs/pathTemplate
endpoints¶
- Required:
yes - Shape: array
Definition Semantics¶
$defs.endpoint¶
- Shape: object
$defs.pathParam¶
- Shape: object
$defs.schemaBinding¶
- Shape: object
$defs.pathTemplate¶
- Shape: string