package nitric.proto.apis.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Service for API routing and handlers

• rpc Serve (stream ClientMessage, stream ServerMessage)

  apis.proto:15

  Serve a route on an API

  message ClientMessage

  apis.proto:30

  ClientMessage sent by the service to the nitric server

  • string id = 1

    globally unique ID of the request/response pair

  • oneof content

    • RegistrationRequest registration_request = 2

      Register an API route handler

    • HttpResponse http_response = 3

      Response to an HTTP request

  message ServerMessage

  apis.proto:84

  ServerMessage sent by the nitric server to the service

  • string id = 1

    globally unique ID of the request/response pair

  • oneof content

    • RegistrationResponse registration_response = 2

      Response to an API serve request

    • HttpRequest http_request = 3

      HTTP request to be routed to the service (handler)

• rpc ApiDetails (ApiDetailsRequest, ApiDetailsResponse)

  apis.proto:18

  Retrieve details about an API

  message ApiDetailsRequest

  apis.proto:21

  • string api_name = 1

  message ApiDetailsResponse

  apis.proto:25

  • string url = 1

Used in: RegistrationRequest

• map<string, ApiWorkerScopes> security = 1

  Apply security definitions to this operation This will be mapped to named ApiSecurityDefinitionResource(s)

• bool security_disabled = 2

  explicitly disable security for this endpoint We need to do this as the default value of a repeated field is always empty so there is no way of knowing if security is explicitly disabled

Used in: ApiWorkerOptions

• repeated string scopes = 1

Used in: HttpRequest, HttpResponse

• repeated string value = 1

Used in: ServerMessage

• string method = 1

  The request method

• string path = 2

  The path of the request

• map<string, HeaderValue> headers = 3

  HTTP request headers

• map<string, QueryValue> query_params = 4

  HTTP Query params

• map<string, string> path_params = 5

  HTTP Path parameters

• bytes body = 6

  HTTP Request body

HttpResponseMessage

Used in: ClientMessage

• int32 status = 1

  The HTTP response status code

• map<string, HeaderValue> headers = 2

  HTTP response headers

• bytes body = 3

  HTTP response body

Used in: HttpRequest

• repeated string value = 1

Used in: ClientMessage

• string api = 1

• string path = 2

• repeated string methods = 3

• optional ApiWorkerOptions options = 4

Used in: ServerMessage

(message has no fields)