package trpc.api

Get desktop application:
View/edit binary Protocol Buffers messages

A custom pattern is used for defining custom HTTP verb.

Used in: HttpRule

• string kind = 1

  The name of this custom HTTP verb.

• string path = 2

  The path matched by this custom verb.

• string selector = 1

  Selects a method to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

• oneof pattern

  Determines the URL pattern is matched by this rules. This pattern can be used with any of the {get|put|post|delete|patch} methods. A custom method can be defined using the 'custom' field.

  • string get = 2

    Maps to HTTP GET. Used for listing and getting information about resources.

  • string put = 3

    Maps to HTTP PUT. Used for replacing a resource.

  • string post = 4

    Maps to HTTP POST. Used for creating a resource or performing an action.

  • string delete = 5

    Maps to HTTP DELETE. Used for deleting a resource.

  • string patch = 6

    Maps to HTTP PATCH. Used for updating a resource.

  • CustomHttpPattern custom = 8

    The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

• string body = 7

  The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

• string response_body = 12

  Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

• repeated HttpRule additional_bindings = 11

  Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).

`JSONSchema` represents properties from JSON SCHEMA taken,and as used, in the OpenAPI v2 spec.

Used in: Schema

• repeated string required = 1

message option schema

• optional JSONSchema json_schema = 1