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

update docs #235

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 0.9.7 Released on 2022-07-21

- update documentation url.

## 0.9.6 Released on 2022-06-09

- using autorest v3.6.1'.
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1005.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

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

Expand Down
3 changes: 1 addition & 2 deletions docs/rules/1006.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

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

**Cause**: This is considered a breaking change. This change requires new api-version.

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

Old specification
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1008.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1009.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1010.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1019.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1020.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

**Cause**: This is considered a breaking change in the same api-version but not breaking in new api-version .
**Cause**: This is considered a a breaking change. This change requires new api-version.
jianyexi marked this conversation as resolved.
Show resolved Hide resolved

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

Expand Down
5 changes: 4 additions & 1 deletion docs/rules/1023.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

**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.

**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.
**Cause**: This is considered a breaking change, exceptions in new api-version:
1 widening integer("int32" -> "int64") in request
2 narrowing integer ("int64" -> "int32") in response .


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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1025.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

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

Expand Down
3 changes: 1 addition & 2 deletions docs/rules/1026.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

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

**Cause**: This is considered a breaking change. This change requires new api-version.

**Cause**: This is considered a breaking change.
**Example**: Property `b` is being changed from `string` to `boolean` without revising api-version.

Old specification
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1033.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Description**: Checks whether an existing property is removed from the previous specification.

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

**Example**: Property `c` is being removed without revising api-version.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1034.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Description**: Checks whether a new required property has added from the previous specification.

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

**Example**: Property `b` is being added without revising api-version.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1035.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Description**: Checks whether an existing operation from a path is removed from the previous specification.

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1038.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Description**: Checks whether a new path is added from the previous specification.

**Cause**: This is considered a additive change in new api-version but a breaking in same api-version.
**Cause**: This is considered a a breaking change. This change requires new api-version.

**Example**: New path `/subscriptions/{subscriptionId}/providers/Microsoft.Contoso/resource1/subResource1` is being added.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/1039.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Description**: Checks whether a new operation in an existing path is added from the previous specification.

**Cause**: This is considered a additive change in new api-version but a breaking in same api-version.
**Cause**: This is considered a a breaking change. This change requires new api-version.

**Example**: Operation `get` in Path `/subscriptions/{subscriptionId}/providers/Microsoft.Contoso/resource1/subResource1` is being added without revising api-version.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ namespace AutoRest.Swagger
/// </summary>
public class ComparisonMessage
{
public static string DocBaseUrl = "https://github.com/Azure/openapi-diff/tree/master/docs/rules/";
public static string DocBaseUrl = "https://github.com/Azure/openapi-diff/tree/main/docs/rules/";

public ComparisonMessage(
MessageTemplate template,
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@azure/oad",
"version": "0.9.6",
"version": "0.9.7",
"author": {
"name": "Microsoft Corporation",
"email": "azsdkteam@microsoft.com",
Expand Down