File layout

This rule attempts to enforce a consistent file layout for proto files, as mandated in AIP-191.

Details

This rule checks for common file layout mistakes, but does not currently check the exhaustive file layout in AIP-191. This rule currently complains if:

  • Services appear below messages.
  • Top-level enums appear below messages.

Examples

Incorrect code for this rule:

// Incorrect.
// Services should appear before messages.
message Book {
  string name = 1;
}

service Library {
  rpc GetBook(GetBookRequest) returns (Book) {
    option (google.api.http) = {
      get: "/v1/{name=publishers/*/books/*}"
    }
  }
}

message GetBookRequest {
  string name = 1;
}

Correct code for this rule:

// Correct.
service Library {
  rpc GetBook(GetBookRequest) returns (Book) {
    option (google.api.http) = {
      get: "/v1/{name=publishers/*/books/*}"
    }
  }
}

message Book {
  string name = 1;
}

message GetBookRequest {
  string name = 1;
}

Disabling

If you need to violate this rule, use a comment at the top of the file. Remember to also include an aip.dev/not-precedent comment explaining why.

// (-- api-linter: core::0191::file-layout=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
syntax = "proto3";

import "google/api/anotations.proto";

message Book {
  string name = 1;
}

service Library {
  rpc GetBook(GetBookRequest) returns (Book) {
    option (google.api.http) = {
      get: "/v1/{name=publishers/*/books/*}"
    }
  }
}

message GetBookRequest {
  string name = 1;
}