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.

Sign up for GitHub

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

Jump to bottom

Swagger change for CustomIpPrefix. Adding four new attributes. #13373

Closed
wants to merge 3 commits into from
Closed

Swagger change for CustomIpPrefix. Adding four new attributes. #13373

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b41b9e
change swagger
Mar 10, 2021
65a7d7f
fix
Mar 11, 2021
da69100
add two parameter in the example
Mar 15, 2021
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
20 changes: 20 additions & 0 deletions ...fication/network/resource-manager/Microsoft.Network/stable/2021-01-01/customIpPrefix.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,26 @@
"type": "string",
"description": "The prefix range in CIDR notation. Should include the start address and the prefix length."
},
"SignedMessage": {
"type": "string",
"description": "Signed message for WAN validation."
},
"AuthorizationMessage": {
"type": "string",
"description": "Authorization message for WAN validation."
},
"CustomIpPrefixParent": {
"$ref": "#/definitions/CustomIpPrefix",
"description": "The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix."
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add examples for these property.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi I fixed the error. But it seems there is a validation failure not related to my code.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi I fixed the error. But it seems there is a validation failure not related to my code.

Ignore it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the example are response message. We don't want AuthorizationMessage and SignedMessage to be shown in the response message. That's why we don't add them in the example.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the example are response message. We don't want AuthorizationMessage and SignedMessage to be shown in the response message. That's why we don't add them in the example.

If AuthorizationMessage and SignedMessage are used in request body, you should add them in examples too. We are using tools to generate tests based on examples. If them are missed, our tests will not cover these properties.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just updated. For CustomIpPrefixParent, only ipv6 /64 has this property. So some example resource doesn't have it.

"Children": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/CustomIpPrefix"
},
"description": "The list of all Children for IPv6 /48 CustomIpPrefix."
},
"commissionedState": {
"type": "string",
"description": "The commissioned state of the Custom IP Prefix.",
Expand Down
6 changes: 4 additions & 2 deletions ...er/Microsoft.Network/stable/2021-01-01/examples/CustomIpPrefixCreateCustomizedValues.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
"resourceGuid": "00000000-0000-0000-0000-00000000",
"cidr": "192.168.254.2/24",
"commissionedState": "Provisioning",
"publicIpPrefixes": []
"publicIpPrefixes": [],
"Children": []
},
"type": "Microsoft.Network/customIpPrefixes"
}
Expand All @@ -48,7 +49,8 @@
"resourceGuid": "00000000-0000-0000-0000-00000000",
"cidr": "192.168.254.2/24",
"commissionedState": "Provisioning",
"publicIpPrefixes": []
"publicIpPrefixes": [],
"Children": []
},
"type": "Microsoft.Network/customIpPrefixes"
}
Expand Down
3 changes: 2 additions & 1 deletion ...work/resource-manager/Microsoft.Network/stable/2021-01-01/examples/CustomIpPrefixGet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
"resourceGuid": "00000000-0000-0000-0000-00000000",
"cidr": "0.0.0.0/24",
"commissionedState": "Commissioned",
"publicIpPrefixes": []
"publicIpPrefixes": [],
"Children": []
},
"type": "Microsoft.Network/customIpPrefixes"
}
Expand Down
6 changes: 4 additions & 2 deletions ...ork/resource-manager/Microsoft.Network/stable/2021-01-01/examples/CustomIpPrefixList.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"resourceGuid": "00000000-0000-0000-0000-00000000",
"cidr": "0.0.0.0/24",
"commissionedState": "Commissioned",
"publicIpPrefixes": []
"publicIpPrefixes": [],
"Children": []
},
"type": "Microsoft.Network/customIpPrefixes"
},
Expand All @@ -32,7 +33,8 @@
"resourceGuid": "00000000-0000-0000-0000-00000000",
"cidr": "0.0.1.0/30",
"commissionedState": "Commissioned",
"publicIpPrefixes": []
"publicIpPrefixes": [],
"Children": []
},
"type": "Microsoft.Network/customIpPrefixes"
}
Expand Down
17 changes: 10 additions & 7 deletions .../resource-manager/Microsoft.Network/stable/2021-01-01/examples/CustomIpPrefixListAll.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
"resourceGuid": "00000000-0000-0000-0000-00000000",
"cidr": "0.0.0.0/24",
"commissionedState": "Commissioned",
"publicIpPrefixes": []
"publicIpPrefixes": [],
"Children": []
},
"type": "Microsoft.Network/customIpPrefixes"
},
Expand All @@ -29,23 +30,25 @@
"properties": {
"provisioningState": "Succeeded",
"resourceGuid": "00000000-0000-0000-0000-00000000",
"cidr": "0.0.1.0/30",
"cidr": "0.0.2.0/23",
"commissionedState": "Commissioned",
"publicIpPrefixes": []
"publicIpPrefixes": [],
"Children": []
},
"type": "Microsoft.Network/customIpPrefixes"
},
{
"name": "test-customipprefix2",
"id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix2",
"name": "test-customipprefix3",
"id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix3",
"etag": "W/\"00000000-0000-0000-0000-00000000\"",
"location": "eastus",
"properties": {
"provisioningState": "Succeeded",
"resourceGuid": "00000000-0000-0000-0000-00000000",
"cidr": "0.0.1.0/22",
"cidr": "0.0.4.0/22",
"commissionedState": "Provisioning",
"publicIpPrefixes": []
"publicIpPrefixes": [],
"Children": []
},
"type": "Microsoft.Network/customIpPrefixes"
}
Expand Down
3 changes: 2 additions & 1 deletion ...source-manager/Microsoft.Network/stable/2021-01-01/examples/CustomIpPrefixUpdateTags.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
"resourceGuid": "00000000-0000-0000-0000-00000000",
"cidr": "192.168.254.2/24",
"commissionedState": "Provisioning",
"publicIpPrefixes": []
"publicIpPrefixes": [],
"Children": []
},
"tags": {
"tag1": "value1",
Expand Down