Batch methods: Get
Rules for AIP-231, covering batch get methods.
Rule name | Description |
---|---|
http-body | Batch Get methods must not have an HTTP body. |
http-method | Batch Get methods must use the GET HTTP verb. |
http-uri-suffix | Batch Get methods must have the correct URI suffix |
plural-method-name | Batch Get methods must have plural names. |
request-message-name | Batch Get methods must have standardized request message names. |
request-names-behavior | Batch Get requests should annotate the `names` field with `google.api.field_behavior`. |
request-names-field | Batch Get RPCs should have a `names` field in the request. |
request-names-reference | Batch Get requests should annotate the `names` field with `google.api.resource_reference`. |
request-parent-field | Batch Get RPCs must have a `parent` field in the request. |
request-parent-reference | Batch Get requests should annotate the `parent` field with `google.api.resource_reference`. |
request-unknown-fields | Batch Get RPCs should not have unexpected fields in the request. |
response-message-name | Batch Get methods must have standardized response message names. |
response-resource-field | Batch Get RPCs must have a repeated field for the resource in the response. |
Note: Because AIPs sometimes cover topics that have some overlap, some rules related to batch get methods may be included in the rules for other AIPs.