Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into dupe_recoveryservices
Browse files Browse the repository at this point in the history
  • Loading branch information
ctaggart committed Nov 3, 2020
2 parents 7454128 + f89a670 commit 6dcdeac
Show file tree
Hide file tree
Showing 1,984 changed files with 237,660 additions and 4,598 deletions.
12 changes: 2 additions & 10 deletions .github/comment.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
---
- rule:
type: checkbox
keywords:
- "Removing API(s)"
- "Updating API in stable version"
onCheckedLabels:
- breakingChange

- rule:
type: checkbox
keywords:
Expand All @@ -25,9 +17,9 @@
- rule:
type: label
label: BreakingChangeReviewRequired
onLabeledComments: "Hi @${PRAuthor}, one or multiple breaking change(s) is detected in your PR. Pls follow [breaking change policy](https://aka.ms/AzBreakingChangesPolicy) to request breaking change review and approval before proceeding swagger PR review. "
onLabeledComments: "Hi @${PRAuthor}, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow [breaking change policy](https://aka.ms/AzBreakingChangesPolicy) to request breaking change review and approval before proceeding swagger PR review. </br> If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback. "

- rule:
type: label
label: ApprovedOkToMerge
label: Approved-OkToMerge
onLabeledComments: "Hi @${PRAuthor},Your PR is approved. Congratulations. </br> <li> If your PR is in public repo (azure-rest-api-specs), PR assignee will merge all updates in the PR shortly afterwards; or pause the PR merge, you need to put on a label <b>DoNotMerge</b> to PR as soon as possible. </li><li>If your PR is in private repo (azure-rest-api-specs-pr), there won’t be PR merge. Please refer to this [wiki](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/205/RP-Scenarios-to-Contribute-to-Swagger?anchor=**public-repository-vs.-private-repository**) for further guidance on how to proceed. </li>"
2 changes: 1 addition & 1 deletion .github/pull_request_assignment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
paths:
- "specification/@(applicationinsights|operationalinsights)/**"
reviewers:
- MyronFanQiu
- kairu-ms

- rule:
paths: "specification/@(resources|powerplatform)/**"
Expand Down
4 changes: 2 additions & 2 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/specification/analysisservices/ @taiwu
/specification/alertsmanagement/ @ofirmanor @olalavi @erangon @orieldar @ilaizi @shakednai1 @khaboasb @orenhor
/specification/apimanagement/ @promoisha @solankisamir
/specification/applicationinsights/ @alexeldeib @reyang @TimothyMothra @ramthi @rajkumar-rangaraj @markwolff @trask @hectorhdzg @lzchen
/specification/applicationinsights/ @alexeldeib @ramthi @markwolff @trask @hectorhdzg @lzchen
/specification/asazure/ @athipp
/specification/authorization/ @darshanhs90 @stankovski
/specification/automation/ @vrdmr
Expand Down Expand Up @@ -58,7 +58,7 @@
/specification/recoveryservicessiterecovery/ @avneeshrai
/specification/redis/ @siddharthchatrolams @timlovellsmith
/specification/relay/ @sethmanheim @v-ajnava
/specification/resources/ @Tiano2017 @rajshah11 @vivsriaus
/specification/resources/ @Azure/arm-template-deployments @rajshah11 @vivsriaus
/specification/scheduler/ @pinwang81
/specification/search/data-plane/ @brjohnstmsft @arv100kri @bleroy @heaths @AlexGhiondea
/specification/search/resource-manager/ @abhi1509 @miwelsh @tjacobhi
Expand Down
12 changes: 11 additions & 1 deletion custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,7 @@ deleteconsumergroup
deletedcertificates
deletedkeys
deletedsecrets
deletedservices
deletedstorage
deletefailed
deleteissuers
Expand Down Expand Up @@ -676,6 +677,7 @@ Gloo
gluster
glusterfs
GOARCH
GPUP
GPUs
Grammarly
GRANTACE
Expand Down Expand Up @@ -1308,6 +1310,8 @@ recoveryservicessiterecovery
recurse
rediscache
rediscachemanagement
RediSearch
redisenterprise
Redshift
Reenabled
Refid
Expand Down Expand Up @@ -1760,6 +1764,7 @@ Unregistering
Unregisters
unrestorable
unsubstituted
Unsynced
untagged
Untracked
unvalidated
Expand Down Expand Up @@ -1984,4 +1989,9 @@ appxmanifest
Appxmanifest
msixpackage
xml
Creds
Creds
unarchive
unarchiving
ssoadfs
Idempotence
privatelinkhub
28 changes: 28 additions & 0 deletions documentation/Semantic-and-Model-Violations-Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ This document lists the set of automated rules that can be validated against swa
| [INTERNAL_ERROR](#INTERNAL_ERROR) | [OAV100](#INTERNAL_ERROR) |
| [REQUEST_VALIDATION_ERROR](#REQUEST_VALIDATION_ERROR) | [OAV109](#REQUEST_VALIDATION_ERROR) |
| [RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE](#RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE) | [OAV111](#RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE) |
| [ROUNDTRIP_INCONSISTENT_PROPERTY](#ROUNDTRIP_INCONSISTENT_PROPERTY) | |
| [ROUNDTRIP_MISSING_PROPERTY](#ROUNDTRIP_MISSING_PROPERTY) | |
| [ROUNDTRIP_ADDITIONAL_PROPERTY](#ROUNDTRIP_ADDITIONAL_PROPERTY) | |


### Validation Warnings
Expand Down Expand Up @@ -799,3 +802,28 @@ This document lists the set of automated rules that can be validated against swa
**How to fix the violation**: Remove this definition if it's not used.


### <a name="ROUNDTRIP_INCONSISTENT_PROPERTY" />ROUNDTRIP_INCONSISTENT_PROPERTY

**Output Message**: The property’s value in the GET response is different from what was set in the preceding PUT request. If it is a read-only property, update the swagger definition for this property to mark it as "readOnly": true. Alternatively, keep the property in the GET schema but remove it from the PUT schema. If the property has a default value, update the Swagger definition for this property to mark it with "default": <default value> annotation.

**Description**: The property’s value in the GET response is different from what was set in the preceding PUT request. This usually happens when the property is read-only so it's value cannot be changed. It is also possible that the property has a default value, and it is set to that value when a null value is included in the PUT request.

**How to fix the violation**: If the property is a read-only, update the swagger definition for this property to mark it as "readOnly": true. Alternatively, keep the property in the GET schema but remove it from the PUT schema. If the property has a default value, update the Swagger definition for this property to mark it with "default": <default value> annotation.


### <a name="ROUNDTRIP_MISSING_PROPERTY" />ROUNDTRIP_MISSING_PROPERTY

**Output Message**: The property is present in the PUT request but is either never returned in the GET response or is returned with a null value. If this is a property that carries a secret such as a password, update the Swagger definition to mark it with the "x-ms-secret": true annotation.

**Description**: The property is present in the PUT request, but in the subsequent GET response, it is either never returned or is returned with a null value, which means the property is write-only and is likely to carry a secret.

**How to fix the violation**: Mark the property definition with the "x-ms-secret": true annotation if the property is a secret.


### <a name="ROUNDTRIP_ADDITIONAL_PROPERTY" />ROUNDTRIP_ADDITIONAL_PROPERTY

**Output Message**: The property is returned in the GET response, but it is not declared in the PUT request. If it is a read-only property, update the swagger definition for this property to mark it as \"readOnly\": true. Alternatively, keep the property in the GET schema but remove it from the PUT schema. If the property has a default value, update the Swagger definition for this property to mark it with \"default\": <default value> annotation.

**Description**: The property was not in the PUT request, but it is returned in the subsequent GET response. This implies that the property is read-only or has a default value.

**How to fix the violation**: If the property is a read-only, update the swagger definition for this property to mark it as "readOnly": true. Alternatively, keep the property in the GET schema but remove it from the PUT schema. If the property has a default value, update the Swagger definition for this property to mark it with "default": <default value> annotation.
2 changes: 1 addition & 1 deletion documentation/sdkautomation/sdk_customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -777,7 +777,7 @@ Output of install instruction script.
}
```

#### InstallInstructionScriptInput Schema
#### InstallInstructionScriptOutput Schema

```jsonc
{
Expand Down
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 6dcdeac

Please sign in to comment.