Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include =disabled in various AIP 203 instructions (#1) #494

Merged
merged 1 commit into from
Feb 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/rules/0203/immutable.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ message Book {
string name = 1;

// Immutable. The title of the book.
// (-- api-linter: core::0203::immutable
// (-- api-linter: core::0203::immutable=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
string title = 2;
}
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/0203/input-only.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ message Book {
string name = 1;

// Input only. The password used to check out this book.
// (-- api-linter: core::0203::input-only
// (-- api-linter: core::0203::input-only=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
string access_password = 2;
}
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/0203/optional-conflict.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ message Book {
string name = 1;

// Optional. The foreword for the book.
// (-- api-linter: core::0203::optional-conflict
// (-- api-linter: core::0203::optional-conflict=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
string foreword = 2 [
(google.api.field_behavior) = OPTIONAL,
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/0203/optional-consistency.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ If you need to violate this rule, use a leading comment above the message.
Remember to also include an [aip.dev/not-precedent][] comment explaining why.

```proto
// (-- api-linter: core::0203::optional-consistency
// (-- api-linter: core::0203::optional-consistency=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
message Book {
string name = 1;
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/0203/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ message Book {
string name = 1;

// Optional. The foreword for the book.
// (-- api-linter: core::0203::optional
// (-- api-linter: core::0203::optional=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
string foreword = 2;
}
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/0203/output-only.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ message Book {
string name = 1;

// Immutable. The title of the book.
// (-- api-linter: core::0203::output-only
// (-- api-linter: core::0203::output-only=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
// Output only. When the book was published.
google.protobuf.Timestamp publish_time = 2;
Expand Down