github.com/googleapis/api-linter@v1.65.2/docs/rules/0135/http-method.md (about) 1 --- 2 rule: 3 aip: 135 4 name: [core, '0135', http-method] 5 summary: Delete methods must use the DELETE HTTP verb. 6 permalink: /135/http-method 7 redirect_from: 8 - /0135/http-method 9 --- 10 11 # Delete methods: DELETE HTTP verb 12 13 This rule enforces that all `Delete` RPCs use the `DELETE` HTTP verb, as 14 mandated in [AIP-135][]. 15 16 ## Details 17 18 This rule looks at any message matching beginning with `Delete`, and complains 19 if the HTTP verb is anything other than `DELETE`. It _does_ check additional 20 bindings if they are present. 21 22 ## Examples 23 24 **Incorrect** code for this rule: 25 26 ```proto 27 // Incorrect. 28 rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) { 29 option (google.api.http) = { 30 post: "/v1/{name=publishers/*/books/*}" // Should be `delete:`. 31 }; 32 } 33 ``` 34 35 **Correct** code for this rule: 36 37 ```proto 38 // Correct. 39 rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) { 40 option (google.api.http) = { 41 delete: "/v1/{name=publishers/*/books/*}" 42 }; 43 } 44 ``` 45 46 ## Disabling 47 48 If you need to violate this rule, use a leading comment above the method. 49 Remember to also include an [aip.dev/not-precedent][] comment explaining why. 50 51 ```proto 52 // (-- api-linter: core::0135::http-method=disabled 53 // aip.dev/not-precedent: We need to do this because reasons. --) 54 rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) { 55 option (google.api.http) = { 56 post: "/v1/{name=publishers/*/books/*}" 57 }; 58 } 59 ``` 60 61 If you need to violate this rule for an entire file, place the comment at the 62 top of the file. 63 64 [aip-135]: https://aip.dev/135 65 [aip.dev/not-precedent]: https://aip.dev/not-precedent