Interface: RouteDefinition

Defined in: packages/contracts/src/routes.ts:12

One gateway route, declared beside the schema it maps onto (D1.4). population and surface are required properties, so a route that omits either does not compile, and the gateway derives its guard from them rather than from the handler's body.

Properties

contract

readonly contract: "request.platform.identity.principal.resolve.v1" | "request.platform.identity.me.get.v1" | "request.*.identity.subject.create.v1" | "request.*.identity.subject.get.v1" | "request.platform.identity.bootstrap.apply.v1" | "request.*.identity.person.create.v1" | "request.*.identity.person.get.v1" | "request.*.identity.person.invite.v1" | "request.*.identity.grant.create.v1" | "request.*.identity.grant.revoke.v1" | "request.*.identity.grant.list.v1" | "event.*.identity.grant.revoked.v1" | "event.*.*.audit.recorded.v1" | "event.platform.gateway.audit.recorded.v1" | "event.platform.gateway-admin.audit.recorded.v1" | "event.platform.bootstrap.audit.recorded.v1" | "request.*.governance.accreditation.apply.v1" | "request.*.governance.accreditation.admit.v1" | "request.*.governance.accreditation.publish.v1" | "request.*.governance.accreditation.get.v1" | "request.*.governance.accreditation.list.v1" | "request.platform.governance.anchor.converge.v1" | "event.*.governance.accreditation.admitted.v1" | "event.*.governance.accreditation.publication-approved.v1" | "request.*.trust.entity-statement.list.v1" | "request.*.trust.entity-statement.preview.v1" | "event.*.trust.entity-statement.published.v1" | "request.*.issuance.identifier.create.v1" | "request.*.issuance.identifier.get.v1" | "request.*.issuance.identifier.list.v1" | "request.*.issuance.identifier.preview.v1" | "request.*.issuance.identifier.publish.v1" | "request.*.issuance.identifier.update.v1" | "request.platform.provisioning.agent.converge.v1" | "request.platform.issuance.registry.probe.v1" | "request.platform.issuance.identifier.converge.v1" | "request.platform.trust.key-store.probe.v1" | "request.platform.issuance.identifier.resolve.v1" | "request.platform.identity.root-sign-in.get.v1" | "event.*.issuance.identifier.requested.v1" | "event.*.provisioning.placement.changed.v1" | "event.*.issuance.identifier.published.v1"

Defined in: packages/contracts/src/routes.ts:18

The registry key of the request the gateway sends.

---

method

readonly method: RouteMethod

Defined in: packages/contracts/src/routes.ts:14

The HTTP method.

---

path

readonly path: string

Defined in: packages/contracts/src/routes.ts:16

The path, with :param segments, under /api/v1.

---

permission

readonly permission: "subject.create" | "subject.read" | "person.create" | "person.read" | "grant.create" | "grant.read" | "grant.revoke" | "accreditation.apply" | "accreditation.admit" | "accreditation.publish" | "accreditation.read" | "entity-statement.read" | "identifier.create" | "identifier.read" | "identifier.publish" | "identifier.update" | "none"

Defined in: packages/contracts/src/routes.ts:29

The permission the handler checks, then the scope; or 'none' for a route that is about the caller and not about an organization (GET /api/v1/me). A 'none' route is authenticated but acts for no organization: the gateway resolves no actor for it and does not read Oktoid-Acting-For. See actsForOrganization.

---

population

readonly population: Population

Defined in: packages/contracts/src/routes.ts:20

Whose issuer verifies the token.

---

surface

readonly surface: Surface

Defined in: packages/contracts/src/routes.ts:22

Which gateway deployment serves it.