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

* Add =disabled to 0203/immutable.md instructions * Add =disabled to 0203/input-only.md instructions * Add =disabled to 0203/optional-conflict.md * Add =disabled to 0203/optional-consistency.md instructions * Add =disabled to 0203/optional.md instructions * Add =disabled to 0203/output-only.md instructions
googleapis · Feb 13, 2020 · 64516bd · 64516bd
1 parent 7b6a2d2
commit 64516bd
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/docs/rules/0203/immutable.md b/docs/rules/0203/immutable.md
@@ -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;
 }

diff --git a/docs/rules/0203/input-only.md b/docs/rules/0203/input-only.md
@@ -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;
 }

diff --git a/docs/rules/0203/optional-conflict.md b/docs/rules/0203/optional-conflict.md
@@ -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,

diff --git a/docs/rules/0203/optional-consistency.md b/docs/rules/0203/optional-consistency.md
@@ -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;

diff --git a/docs/rules/0203/optional.md b/docs/rules/0203/optional.md
@@ -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;
 }

diff --git a/docs/rules/0203/output-only.md b/docs/rules/0203/output-only.md
@@ -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;