Skip to content

Commit ade8771

Browse files
committed
update docs
1 parent 87568dc commit ade8771

File tree

15 files changed

+18
-17
lines changed

15 files changed

+18
-17
lines changed

docs/rules/1005.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Description**: Checks whether an existing path is removed from the previous specification.
44

5-
**Cause**: This is considered a breaking change. This change requires new api-version.
5+
**Cause**: This is considered a breaking change even in a new api-version.
66

77
**Example**: Path `/subscriptions/{subscriptionId}/providers/Microsoft.Contoso/resource1/subResource1` is being removed without revising api-version.
88

docs/rules/1006.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
**Description**: Checks whether an existing model definition is removed from the previous specification.
44

5-
**Cause**: This is considered a breaking change. This change requires new api-version.
6-
5+
**Cause**: This is considered a breaking change even in a new api-version.
76
**Example**: Model definition `CreateParameters` is being removed without revising api-version.
87

98
Old specification

docs/rules/1008.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Description**: Checks whether an existing operation's `operationId` is changed from the previous specification.
44

5-
**Cause**: This is considered a breaking change. This change requires new api-version.
5+
**Cause**: This is considered a breaking change even in a new api-version.
66

77
**Example**: `operationId` of Operation `get` from Path `/subscriptions/{subscriptionId}/providers/Microsoft.Contoso/resource1` is being updated without revising api-version.
88

docs/rules/1009.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Description**: Checks whether required parameter is removed / made optional from the previous specification.
44

5-
**Cause**: TBD.
5+
**Cause**: This is considered a breaking change even in a new api-version.
66

77
**Example**: Required parameter `c` is being removed without revising api-version.
88

docs/rules/1010.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Description**: Checks whether new required parameter is introduced from the previous specification.
44

5-
**Cause**: This is considered a breaking change. This change requires new api-version.
5+
**Cause**: This is considered a breaking change even in a new api-version.
66

77
**Example**: New required parameter `c` is introduced without revising api-version.
88

docs/rules/1019.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Description**: Checks whether an existing enum property has removed allowed values from the previous specification.
44

5-
**Cause**: This is considered a breaking change. This change requires new api-version.
5+
**Cause**: This is considered a breaking change even in a new api-version.
66

77
**Example**: Enum Property `b` is removing allowed values without revising api-version.
88

docs/rules/1020.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Description**: Checks whether an existing enum property has added more allowed values from the previous specification.
44

5-
**Cause**: This is considered a breaking change in the same api-version but not breaking in new api-version .
5+
**Cause**: This is considered a a breaking change. This change requires new api-version.
66

77
**Example**: Enum Property `b` is adding more allowed values without revising api-version.
88

docs/rules/1023.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
**Description**: Checks whether any existing property's [format](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#dataTypeFormat) element has changed from the previous specification.
44

5-
**Cause**: This is considered a breaking change in most cases except widening integer("int32" -> "int64") in request and narrowing integer ("int64" -> "int32") in response which are not breaking change in new api-version.
5+
**Cause**: This is considered a breaking change, exceptions in new api-version:
6+
1 widening integer("int32" -> "int64") in request
7+
2 narrowing integer ("int64" -> "int32") in response .
8+
69

710
**Example**: Property `a` of Parameter `CreateParameters` changed format from `int64` to `int32` in the new version.
811

docs/rules/1025.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Description**: Checks whether an existing property's `required` status is changed from the previous specification.
44

5-
**Cause**: This is considered a breaking change in the same api-version but not breaking in new api-version .
5+
**Cause**: This is considered a a breaking change. This change requires new api-version.
66

77
**Example**: `required` status for parameter `b` is changed from `false` to `true` without revising api-version.
88

docs/rules/1026.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
**Description**: Checks whether an existing property has changed the type from the previous specification.
44

5-
**Cause**: This is considered a breaking change. This change requires new api-version.
6-
5+
**Cause**: This is considered a breaking change.
76
**Example**: Property `b` is being changed from `string` to `boolean` without revising api-version.
87

98
Old specification

0 commit comments

Comments
 (0)