Criteria-based delete
Rules for AIP-165, covering criteria-based delete.
| Rule name | Description |
|---|---|
| http-body | Purge methods should use `*` as the HTTP body. |
| http-method | Purge methods must use the POST HTTP verb. |
| http-parent-variable | Purge methods must map the parent field to the URI. |
| http-uri-suffix | Purge methods must have the correct URI suffix |
| request-filter-behavior | Purge requests should annotate the `filter` field with `google.api.field_behavior`. |
| request-filter-field | Purge RPCs must have a `filter` field in the request. |
| request-force-field | Purge RPCs must have a `force` field in the request. |
| request-message-name | Purge methods must have standardized request message names. |
| request-parent-behavior | Purge requests should annotate the `parent` field with `google.api.field_behavior`. |
| request-parent-field | Purge RPCs must have a `parent` field in the request. |
| request-parent-reference | Purge requests should annotate the `parent` field with `google.api.resource_reference`. |
| response-message-name | Purge methods must return a long-running operation. |
| response-purge-count-field | Purge RPCs must have a `purge_count` field in the response. |
| response-purge-sample-field | Purge RPCs must have a `purge_sample` field in the response. |
| response-purge-sample-reference | Purge responses should annotate the `purge_sample` field with `google.api.resource_reference`. |
Note: Because AIPs sometimes cover topics that have some overlap, some rules related to criteria-based delete may be included in the rules for other AIPs.
View on GitHub