Skip to content

Commit 43f30d1

Browse files
Merge branch 'main' into feature/cplat-2021-10-01
2 parents 19f0734 + 31e3d74 commit 43f30d1

File tree

4,281 files changed

+578306
-7071
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,281 files changed

+578306
-7071
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Otherwise your PR may be subject to ARM review requirements. Complete the follow
4343
- Adding a new service
4444
- Adding new API(s)
4545
- Adding a new API version
46-
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
46+
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the [wiki](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version).
4747

4848
- [ ] Ensure you've reviewed following [guidelines](https://aka.ms/rpguidelines) including [ARM resource provider contract](https://github.com/Azure/azure-resource-manager-rpc) and [REST guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md). Estimated time (4 hours). This is required before you can request review from ARM API Review board.
4949

.github/issue_assignment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
- rule:
33
booleanFilterExpression: "APIStewardshipBoard-ReviewRequested"
44
assignees:
5-
- mikekistler
5+
66

.github/pull_request_assignment.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,14 @@
152152
reviewers:
153153
- zhenglaizhang
154154

155+
- rule:
156+
paths:
157+
- "specification/videoanalyzer/resource-manager/**"
158+
- "specification/cognitiveservices/resource-manager/**"
159+
- "specification/dataprotection/**"
160+
reviewers:
161+
- xiaoxuqi-ms
162+
155163
- rule:
156164
paths:
157165
- "documentation/**"
@@ -190,4 +198,4 @@
190198
- changlong-liu
191199
- msyyc
192200
- qiaozha
193-
- weidong
201+
- dw511214992

CODEOWNERS

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
/specification/batch/ @paterasMSFT @dpwatrous
1212
/specification/batchai/ @alexanderyukhanov
1313
/specification/billing/ @wilcobmsft @asarkar84
14-
/specification/cdn/ @csmengwan @injyzarif @prakharsharma10
14+
/specification/cdn/ @jorinmejia @yunhemsft @jessicl-ms @sinadell @rrahulms @t-bzhan
1515
/specification/cognitiveservices/ @felixwa @yangyuan
1616
/specification/compute/ @bilaakpan-ms @sandido @dkulkarni-ms @haagha @madewithsmiles @MS-syh2qs @grizzlytheodore @hyonholee @mabhard @danielli90 @smotwani @ppatwa @vikramd-ms @savyasachisamal @yunusm @ZhidongPeng @nkuchta @maheshnemichand @najams @changov
1717
/specification/consumption/ @kjeur @panda-wang
@@ -20,7 +20,7 @@
2020
/specification/containerservice/ @yangl900
2121
/specification/cosmos-db/ @dmakwana @MehaKaushik @wmengmsft @shurd
2222
/specification/customer-insights/ @tjlvtao
23-
/specification/datafactory/ @shawnxzq @zhangyd2015
23+
/specification/datafactory/ @Frey-Wang @zhangyd2015 @davidzhaoyue
2424
/specification/datalake-analytics/ @ro-joowan
2525
/specification/datalake-store/ @ro-joowan
2626
/specification/datamigration/ @hitenjava
@@ -85,4 +85,4 @@
8585
/specification/**/resource-manager/**/readme.az.md @jsntcy @qiaozha
8686
/specification/**/resource-manager/**/readme.cli.md @jsntcy @qiaozha
8787
/specification/**/resource-manager/**/readme.go.md @ArcturusZhang
88-
/specification/**/resource-manager/**/readme.python.md @msyyc @RAY-316 @BigCat20196
88+
/specification/**/resource-manager/**/readme.python.md @msyyc @BigCat20196

arm-compute/quickstart-templates/aliases.json

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
},
3030
"openSUSE-Leap": {
3131
"publisher": "SUSE",
32-
"offer": "openSUSE-Leap",
33-
"sku": "42.3",
32+
"offer": "opensuse-leap-15-3",
33+
"sku": "gen2",
3434
"version": "latest"
3535
},
3636
"RHEL": {
@@ -41,8 +41,8 @@
4141
},
4242
"SLES": {
4343
"publisher": "SUSE",
44-
"offer": "SLES",
45-
"sku": "15",
44+
"offer": "sles-15-sp3",
45+
"sku": "gen2",
4646
"version": "latest"
4747
},
4848
"UbuntuLTS": {
@@ -53,6 +53,12 @@
5353
}
5454
},
5555
"Windows": {
56+
"Win2022Datacenter": {
57+
"publisher": "MicrosoftWindowsServer",
58+
"offer": "WindowsServer",
59+
"sku": "2022-Datacenter",
60+
"version": "latest"
61+
},
5662
"Win2019Datacenter": {
5763
"publisher": "MicrosoftWindowsServer",
5864
"offer": "WindowsServer",

custom-words.txt

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
A128CBCPAD
1+
A128CBCPAD
22
A192CBCPAD
33
A256CBCPAD
44
AADDS
@@ -301,6 +301,10 @@ browsable
301301
bruceper
302302
Bsaling
303303
bsls
304+
Buildpack
305+
Buildpacks
306+
buildpack
307+
buildpacks
304308
Burstable
305309
byoa
306310
BYOC
@@ -456,6 +460,7 @@ csrs
456460
currentbillingfeatures
457461
currentuser
458462
customerinsights
463+
customhostname
459464
customhostnames
460465
customimages
461466
customimagesearch
@@ -478,6 +483,7 @@ Cyrl
478483
dacl
479484
dailyforecast
480485
dailyhistorical
486+
dapr
481487
darkgrey
482488
Darussalam
483489
databox
@@ -531,6 +537,7 @@ decisionrule
531537
decodable
532538
Decompounder
533539
dedicatedhsm
540+
dedup
534541
deduping
535542
deduplication
536543
defanged
@@ -627,6 +634,7 @@ Dtus
627634
duration'PT
628635
dwgzippackage
629636
dynamicpersongroups
637+
Dynatrace
630638
EAPMSCHA
631639
EAPMSCHAP
632640
EAPTLS
@@ -1390,11 +1398,13 @@ offboard
13901398
offboards
13911399
officedocument
13921400
OLTP
1401+
OIDC
13931402
onboarded
13941403
Onboarding
13951404
Onboards
13961405
ondemand
13971406
ondemandgc
1407+
onedeploy
13981408
onmachine
13991409
omex
14001410
onmicrosoft
@@ -1535,6 +1545,7 @@ Preprovisioned
15351545
Prerelease
15361546
prerestore
15371547
pretrained
1548+
prevalidated
15381549
previewrows
15391550
prevsharesnapshot
15401551
prevsnapshot
@@ -1770,6 +1781,7 @@ runtimes
17701781
rwdlacup
17711782
rwxrw
17721783
Saas
1784+
Safenet
17731785
salesforcetables
17741786
saling
17751787
salinuxvm
@@ -1919,6 +1931,7 @@ sqldatabase
19191931
SQLDB
19201932
SQLDW
19211933
SQLMI
1934+
sqlmigration
19221935
sqlpool
19231936
Sqlpools
19241937
SQLRDS
@@ -2404,6 +2417,7 @@ DOCM
24042417
PPSX
24052418
PPTM
24062419
XLSM
2420+
xcool
24072421
DOCM
24082422
multislot
24092423
noAddressPrefixes
@@ -2427,6 +2441,8 @@ Ctlr
24272441
vcenters
24282442
Mwarev
24292443
pmem
2444+
actuals
2445+
Actuals
24302446
rawphysical
24312447
rawvirtual
24322448
sesparse
@@ -2439,4 +2455,22 @@ stackset
24392455
CSPM
24402456
autoprovisioning
24412457
schemagroups
2442-
videoanalyzer
2458+
videoanalyzer
2459+
Unsecure
2460+
Noreuse
2461+
loadtestservice
2462+
testmanager
2463+
additionalmetrics
2464+
loadtests
2465+
appcomponents
2466+
clientmetrics
2467+
vusers
2468+
clientmetric
2469+
testruns
2470+
odatatestxx
2471+
testrun
2472+
loadtest
2473+
xvalue
2474+
yvalue
2475+
servermetrics
2476+
IAASVM

documentation/Semantic-and-Model-Violations-Reference.md

Lines changed: 51 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ This document lists the set of automated rules that can be validated against swa
99
| [CIRCULAR_INHERITANCE](#CIRCULAR_INHERITANCE) | |
1010
| [DUPLICATE_PARAMETER](#DUPLICATE_PARAMETER) | |
1111
| [EMPTY_PATH_PARAMETER_DECLARATION](#EMPTY_PATH_PARAMETER_DECLARATION) | |
12+
| [EQUIVALENT_PATH](#EQUIVALENT_PATH) | |
13+
| [OBJECT_MISSING_REQUIRED_PROPERTY_DEFINITION](#OBJECT_MISSING_REQUIRED_PROPERTY_DEFINITION) | |
14+
| [OBJECT_MISSING_REQUIRED_PROPERTY_SCHEMA](#OBJECT_MISSING_REQUIRED_PROPERTY_SCHEMA) | |
1215
| [DUPLICATE_OPERATIONID](#DUPLICATE_OPERATIONID) | |
1316
| [MULTIPLE_BODY_PARAMETERS](#MULTIPLE_BODY_PARAMETERS) | |
1417
| [INVALID_PARAMETER_COMBINATION](#INVALID_PARAMETER_COMBINATION) | |
@@ -63,6 +66,7 @@ This document lists the set of automated rules that can be validated against swa
6366
| [READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST](#READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST) | |
6467
| [SCHEMA_VALIDATION_FAILED](#SCHEMA_VALIDATION_FAILED) | |
6568
| [SECRET_PROPERTY](#SECRET_PROPERTY) | |
69+
| [WRITEONLY_PROPERTY_NOT_ALLOWED_IN_RESPONSE](#WRITEONLY_PROPERTY_NOT_ALLOWED_IN_RESPONSE) | |
6670
| [DISCRIMINATOR_VALUE_NOT_FOUND](#DISCRIMINATOR_VALUE_NOT_FOUND) | |
6771
| [INVALID_XMS_DISCRIMINATOR_VALUE](#INVALID_XMS_DISCRIMINATOR_VALUE) | [OAV133](#INVALID_XMS_DISCRIMINATOR_VALUE) |
6872
| [DISCRIMINATOR_PROPERTY_NOT_FOUND](#DISCRIMINATOR_PROPERTY_NOT_FOUND) | [OAV134](#DISCRIMINATOR_PROPERTY_NOT_FOUND) |
@@ -83,7 +87,7 @@ This document lists the set of automated rules that can be validated against swa
8387
| [RESPONSE_SCHEMA_NOT_IN_SPEC](#RESPONSE_SCHEMA_NOT_IN_SPEC) | [OAV113](#RESPONSE_SCHEMA_NOT_IN_SPEC) |
8488
| [RESPONSE_STATUS_CODE_NOT_IN_SPEC](#RESPONSE_STATUS_CODE_NOT_IN_SPEC) | [OAV112](#RESPONSE_STATUS_CODE_NOT_IN_SPEC) |
8589
| [RESPONSE_VALIDATION_ERROR](#RESPONSE_VALIDATION_ERROR) | [OAV108](#RESPONSE_VALIDATION_ERROR) |
86-
| [X-MS-EXAMPLE_NOTFOUND_ERROR](#X-MS-EXAMPLE_NOTFOUND_ERROR) | [OAV107](#X-MS-EXAMPLE_NOTFOUND_ERROR) |
90+
| [XMS_EXAMPLE_NOTFOUND_ERROR](#XMS_EXAMPLE_NOTFOUND_ERROR) | [OAV107](#XMS_EXAMPLE_NOTFOUND_ERROR) |
8791
| [ERROR_IN_PREPARING_REQUEST](#ERROR_IN_PREPARING_REQUEST) | [OAV106](#ERROR_IN_PREPARING_REQUEST) |
8892
| [REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND) | [OAV105](#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND) |
8993
| [JSON_PARSING_ERROR](#JSON_PARSING_ERROR) | [OAV104](#JSON_PARSING_ERROR) |
@@ -97,6 +101,7 @@ This document lists the set of automated rules that can be validated against swa
97101
| [LRO_RESPONSE_CODE](#LRO_RESPONSE_CODE) | |
98102
| [LRO_RESPONSE_HEADER](#LRO_RESPONSE_HEADER) | |
99103
| [MISSING_RESOURCE_ID](#MISSING_RESOURCE_ID) | |
104+
| [INVALID_RESPONSE_HEADER](#INVALID_RESPONSE_HEADER) | |
100105

101106

102107
### Validation Warnings
@@ -172,6 +177,22 @@ This document lists the set of automated rules that can be validated against swa
172177

173178
**How to fix the violation**: Remove one of the equivalent paths or rename it.
174179

180+
### <a name="OBJECT_MISSING_REQUIRED_PROPERTY_DEFINITION" />OBJECT_MISSING_REQUIRED_PROPERTY_DEFINITION
181+
182+
**Output Message**: Missing required property definition: {0}.
183+
184+
**Description**: Property indicated as required in "required" array for the model is missing its definition.
185+
186+
**How to fix the violation**: Verify that the properties included in the "required" array have all been defined in swagger.
187+
188+
### <a name="OBJECT_MISSING_REQUIRED_PROPERTY_SCHEMA" />OBJECT_MISSING_REQUIRED_PROPERTY_SCHEMA
189+
190+
**Output Message**: Missing required property: {0}.
191+
192+
**Description**: Property indicated as required according to [OpenAPI 2.0 specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md) for this schema.
193+
194+
**How to fix the violation**: Adding this property to schema in swagger.
195+
175196
### <a name="EMPTY_PATH_PARAMETER_DECLARATION" />EMPTY_PATH_PARAMETER_DECLARATION
176197

177198
**Output Message**: Path parameter declaration cannot be empty: {0}.
@@ -769,14 +790,6 @@ This document lists the set of automated rules that can be validated against swa
769790

770791
**How to fix the violation**: See inner details for the violations and fix.
771792

772-
### <a name="X-MS-EXAMPLE_NOTFOUND_ERROR" />X-MS-EXAMPLE_NOTFOUND_ERROR
773-
774-
**Output Message**: x-ms-example not found in {0}.
775-
776-
**Description**: Each operation should have example defined.
777-
778-
**How to fix the violation**: Add `x-ms-example` declaration for this operation.
779-
780793
### <a name="ERROR_IN_PREPARING_REQUEST" />ERROR_IN_PREPARING_REQUEST
781794

782795
**Description**: Error when preparing the request for validation.
@@ -818,7 +831,15 @@ This document lists the set of automated rules that can be validated against swa
818831

819832
**Description**: The secret is not allowed to return in response when it's annotated with x-ms-secret:true.
820833

821-
**How to fix the violation**: Remove this secret value from the response.
834+
**How to fix the violation**: Remove this secret value from the response in example or in traffic payload.
835+
836+
### <a name="WRITEONLY_PROPERTY_NOT_ALLOWED_IN_RESPONSE" />WRITEONLY_PROPERTY_NOT_ALLOWED_IN_RESPONSE
837+
838+
**Output Message**: Write-only property {0} is not allowed in the response.
839+
840+
**Description**: Write only property is not allowed to return in response when it's annotated with "x-ms-mutability": ["create", "update"].
841+
842+
**How to fix the violation**: Remove this property from the response in example or in traffic payload.
822843

823844

824845
### <a name="ROUNDTRIP_INCONSISTENT_PROPERTY" />ROUNDTRIP_INCONSISTENT_PROPERTY
@@ -861,22 +882,38 @@ This document lists the set of automated rules that can be validated against swa
861882

862883
**Output Message**: Respond to the initial request of a long running operation, Patch/Post call must return 201 or 202, Delete call must return 202 or 204, Put call must return 202 or 201 or 200, but {statusCode} being returned.
863884

864-
**Description**: Long running operation must return specific response code as per http method type when this operation is annotated with x-ms-long-running-operation:true. See [RPC - Asynchronous Operations](https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations) for more details.
885+
**Description**: Long running operation must return specific response code as per http method type in example or in traffic payload when this operation is annotated with x-ms-long-running-operation:true. See [RPC - Asynchronous Operations](https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations) for more details.
865886

866-
**How to fix the violation**: Correct the response code per the guidance or remove annotation of x-ms-long-running-operation.
887+
**How to fix the violation**: Correct the response code per the guidance or remove annotation of x-ms-long-running-operation in example or in traffic payload.
867888

868889
### <a name="LRO_RESPONSE_HEADER" />LRO_RESPONSE_HEADER
869890

870891
**Output Message**: Long running operation should return {header} in header but not being provided.
871892

872893
**Description**: Long running operation must return location header or azure-AsyncOperation header in response when this operation is annotated with x-ms-long-running-operation:true.
873894

874-
**How to fix the violation**: Adding one of these headers to the response.
895+
**How to fix the violation**: Adding one of these headers to the response in example or in traffic payload.
875896

876897
### <a name="MISSING_RESOURCE_ID" />MISSING_RESOURCE_ID
877898

878899
**Output Message**: id is required to return in response of GET/PUT resource calls but not being provided.
879900

880901
**Description**: `id` is a required field of azure resource to return in response body of each GET or PUT call when this resource is annotated as x-ms-azure-resource: true. This field is important to the platform because it is used as the identifier for references on other objects. e.g. "id": "/subscriptions/{id}/resourceGroups/{group}/providers/{rpns}/{type}/{name}".
881902

882-
**How to fix the violation**: Adding id to the response body.
903+
**How to fix the violation**: Adding id to the response body in example or in traffic payload.
904+
905+
### <a name="XMS_EXAMPLE_NOTFOUND_ERROR" />XMS_EXAMPLE_NOTFOUND_ERROR
906+
907+
**Output Message**: "x-ms-example" not found in {"operationId"} operation.
908+
909+
**Description**: Example is required to provide for each operation and it's annotated by "x-ms-example". Example is important because it is displayed in rest API document. See [x-ms-examples](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/x-ms-examples.md) for details.
910+
911+
**How to fix the violation**: Adding separated example JSON file and reference it with "x-ms-examples" annotation in swagger.
912+
913+
### <a name="INVALID_RESPONSE_HEADER" />INVALID_RESPONSE_HEADER
914+
915+
**Output Message**: Header {header} is required in response but not provided.
916+
917+
**Description**: {header} is declared in response schema in swagger but it's not provided in response in example or in traffic payload.
918+
919+
**How to fix the violation**: Adding this {header} to the response in example or in traffic payload.

0 commit comments

Comments
 (0)