github.com/googleapis/api-linter@v1.65.2/docs/rules/0233/http-method.md (about)

     1  ---
     2  rule:
     3    aip: 233
     4    name: [core, '0233', http-method]
     5    summary: Batch Create methods must use the POST HTTP verb.
     6  permalink: /233/http-method
     7  redirect_from:
     8    - /0233/http-method
     9  ---
    10  
    11  # Batch Create methods: POST HTTP verb
    12  
    13  This rule enforces that all `BatchCreate` RPCs use the `POST` HTTP verb, as
    14  mandated in [AIP-233][].
    15  
    16  ## Details
    17  
    18  This rule looks at any RPCs with the name beginning with `BatchCreate`, and
    19  complains if the HTTP verb is anything other than `POST`.
    20  
    21  ## Examples
    22  
    23  **Incorrect** code for this rule:
    24  
    25  ```proto
    26  // Incorrect.
    27  rpc BatchCreateBooks(BatchCreateBooksRequest) returns (BatchCreateBooksResponse) {
    28    option (google.api.http) = {
    29      put: "/v1/{parent=publishers/*}/books:batchCreate"  // Should be `post:`.
    30      body: "*"
    31    };
    32  }
    33  ```
    34  
    35  **Correct** code for this rule:
    36  
    37  ```proto
    38  // Correct.
    39  rpc BatchCreateBooks(BatchCreateBooksRequest) returns (BatchCreateBooksResponse) {
    40    option (google.api.http) = {
    41      post: "/v1/{parent=publishers/*}/books:batchCreate"
    42      body: "*"
    43    };
    44  }
    45  ```
    46  
    47  ## Disabling
    48  
    49  If you need to violate this rule, use a leading comment above the method.
    50  Remember to also include an [aip.dev/not-precedent][] comment explaining why.
    51  
    52  ```proto
    53  // (-- api-linter: core::0233::http-method=disabled
    54  //     aip.dev/not-precedent: We need to do this because reasons. --)
    55  rpc BatchCreateBooks(BatchCreateBooksRequest) returns (BatchCreateBooksResponse) {
    56    option (google.api.http) = {
    57      get: "/v1/{parent=publishers/*}/books:batchCreate" // Should be `post:`.
    58      body: "*"
    59    };
    60  }
    61  ```
    62  
    63  If you need to violate this rule for an entire file, place the comment at the
    64  top of the file.
    65  
    66  [aip-233]: https://aip.dev/233
    67  [aip.dev/not-precedent]: https://aip.dev/not-precedent