Standard methods: List
Rules for AIP-132, covering list methods.
Rule name | Description |
---|---|
http-body | List methods must not have an HTTP body. |
http-method | List methods must use the GET HTTP verb. |
http-uri-parent | List methods must map the parent field to the URI. |
method-signature | List RPCs should annotate a method signature of "parent". |
request-field-types | List RPCs should have fields with consistent types. |
request-message-name | List methods must have standardized request message names. |
request-parent-behavior | List RPCs should annotate the `parent` field with `google.api.field_behavior`. |
request-parent-field | List RPCs must have a `parent` field in the request. |
request-parent-reference | List RPCs should annotate the `parent` field with `google.api.resource_reference`. |
request-parent-required | List RPCs must have a `parent` field in the request. |
request-parent-valid-reference | List RPCs should reference the parent resource, not the listed resource. |
request-required-fields | List RPCs must not have unexpected required fields in the request. |
request-show-deleted-required | List requests must have a `show-deleted` field for resources supporting soft delete. |
request-unknown-fields | List RPCs should not have unexpected fields in the request. |
resource-reference-type | List should use a `child_type` reference to the paginated resource. |
response-message-name | List methods must have standardized response message names. |
response-unknown-fields | List RPCs should not have unexpected fields in the response. |
Note: Because AIPs sometimes cover topics that have some overlap, some rules related to list methods may be included in the rules for other AIPs.