Standard methods: Get
Rules for AIP-131, covering get methods.
Rule name | Description |
---|---|
http-body | Get methods must not have an HTTP body. |
http-method | Get methods must use the GET HTTP verb. |
http-uri-name | Get methods must map the name field to the URI. |
method-signature | Get RPCs should annotate a method signature of "name". |
request-message-name | Get methods must have standardized request message names. |
request-name-behavior | Get RPCs should annotate the `name` field with `google.api.field_behavior`. |
request-name-field | Get RPCs must have a `string name` field in the request. |
request-name-reference | Get RPCs should annotate the `name` field with `google.api.resource_reference`. |
request-name-reference-type | The `google.api.resource_reference` on the `name` field of a Get RPC request message should use `type`, not `child_type`. |
request-name-required | Get RPCs must have a `name` field in the request. |
request-required-fields | Get RPCs must not have unexpected required fields in the request. |
request-unknown-fields | Get RPCs should not have unexpected fields in the request. |
response-message-name | Get methods must return the resource. |
synonyms | Get methods must be named starting with "Get". |
Note: Because AIPs sometimes cover topics that have some overlap, some rules related to get methods may be included in the rules for other AIPs.