API Endpoint

type: api-endpoint

A REST or gRPC endpoint card. REST: method/path/params/body/responses. gRPC: service/method/streaming/messages.

Examples

- id: getUser
  type: api-endpoint
  protocol: rest
  method: GET
  path: /users/:id
  pathParams:
    - { name: id, type: uuid, required: true }
  responses:
    - { status: "200", description: User }
    - { status: "404", description: Not found }

- id: streamUsers
  type: api-endpoint
  protocol: grpc
  service: UserService
  method: StreamUsers
  streaming: server
  requestMessage: ListUsersRequest
  replyMessage: User
  errors:
    - { status: NOT_FOUND, description: No such tenant }