Skip to content

Commit

Permalink
Merge branch 'master' into add-terraform-config-to-customproviders-co…
Browse files Browse the repository at this point in the history
…nfig

# Conflicts:
#	specification/customproviders/resource-manager/readme.trenton.md
  • Loading branch information
dw511214992 committed Apr 17, 2020
2 parents 055ea5b + 2e49dd2 commit 4948c75
Show file tree
Hide file tree
Showing 1,332 changed files with 149,396 additions and 3,442 deletions.
259 changes: 166 additions & 93 deletions .azure-pipelines-preproduction/package-lock.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions .azure-pipelines-preproduction/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
"description": "Tests for Azure REST API Specifications",
"license": "MIT",
"devDependencies": {
"@azure/avocado": "^0.6.2",
"@azure/rest-api-specs-scripts": "^0.6.8",
"@azure/avocado": "^0.6.3",
"@azure/rest-api-specs-scripts": "^0.7.2",
"@ts-common/commonmark-to-markdown": "^1.2.0",
"@ts-common/fs": "0.2.0",
"@ts-common/iterator": "^0.3.6",
Expand Down
8 changes: 6 additions & 2 deletions .github/assignment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
- "specification/network/**"
reviewers:
- lirenhe
- zikalino
- MyronFanQiu

- rule:
Expand Down Expand Up @@ -83,6 +82,12 @@
- fengzhou-msft
- yungezz

- rule:
paths:
- "specification/mixedreality/**"
reviewers:
- leni-msft

- rule:
paths:
- "specification/portal/**"
Expand Down Expand Up @@ -121,7 +126,6 @@
reviewers:
- yungezz
- zikalino
- yaohaizh
- erich-wang
- NullMDR
- raych1
Expand Down
2 changes: 1 addition & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
/specification/insights/ @gucalder
/specification/intune/ @vrmurthy01
/specification/iothub/ @rkmanda
/specification/keyvault/ @schaabs @heaths
/specification/keyvault/ @heaths @randallilama @jlichwa
/specification/logic/ @pankajsn @tonytang-microsoft-com
/specification/machinelearning/ @nonstatic2014
/specification/machinelearningcompute/ @shutchings
Expand Down
6 changes: 6 additions & 0 deletions cSpell.json
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,12 @@
"Exprired"
]
},
{
"filename": "**/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json",
"words": [
"Exprired"
]
},
{
"filename": "**/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/TasksCommon.json",
"words": [
Expand Down
11 changes: 11 additions & 0 deletions custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,7 @@ deletedsecrets
deletedstorage
deletefailed
deleteissuers
deleteprivateendpointconnection
deletesas
demorun
denylist
Expand Down Expand Up @@ -484,6 +485,7 @@ endswith
endtime
Enein
engagementfabric
endzone
enquoted
entitydocument
entitysearch
Expand Down Expand Up @@ -586,6 +588,8 @@ GETFILESTATUS
getissuers
getjob
getkey
getprivateendpointconnection
getprivatelinkresources
getsas
getskus
getssotoken
Expand Down Expand Up @@ -649,6 +653,7 @@ hybridconnection
hybriddata
hybriddatamanager
Hyperdrive
Hypernet
Hyperscale
hyperv
Iaas
Expand Down Expand Up @@ -695,13 +700,15 @@ iothub
iothubprovisioningservices
iotspaces
iotspacesservice
ipam
ipconfig
ipconfiguration
ipconfigurations
ipfilterrules
Ipsec
ipssl
ipgroups
IPAM
iscloneable
Iscsi
iscsiservers
Expand Down Expand Up @@ -796,6 +803,8 @@ listissuers
listjobs
listkeys
listprebuilts
listprivateendpointconnections
listprivatelinkresources
listsas
listsecrets
LISTSTATUS
Expand Down Expand Up @@ -1153,6 +1162,7 @@ RAGRS
RAGZRS
randint
Rankable
ratelimit
ravbhatnagar
rawxml
rbac
Expand Down Expand Up @@ -1588,6 +1598,7 @@ unvalidated
unwrapkey
updatecertificate
updatehostname
updateprivateendpointconnection
updateproperties
upgradeos
uploadbatchservicelogs
Expand Down
72 changes: 70 additions & 2 deletions documentation/ci-fix.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,81 @@ If your problem is some existing error name that is not a word and need to supre
Please run the following command (from an administrator Node.js command prompt if running on Windows):

```
npm install; npm run prettier-fix
npm install
npm run prettier-fix
```

Or if you want to fix specified service:

```
npm install; npm run prettier -- --write "specification/<service>/**/*.json"
npm install
npm run prettier -- --write "specification/<service>/**/*.json"
```

Then please commit and push changes made by prettier.

## Model Validation

Run Model Validation locally:
```
npm install -g oav
oav validate-example <swagger-spec-path>
```
Please see [readme](https://github.com/Azure/oav/blob/master/README.md) for how to install or run tool in details.
Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/static-validation/static/errors/default)
Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance.

## Semantic Validation
Run Semantic Validation locally:
```
npm install -g oav
oav validate-spec <swagger-spec-path>
```
Please see [readme](https://github.com/Azure/oav/blob/master/README.md) for how to install or run tool in details.
Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/static-validation/static/errors/default)
Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance.

## Breaking Change Check

run oad locally (the breaking change is reported by oad tool):
```
npm install -g oad
oad compare <old-spec-path> <new-spec-path>
```
Please see [readme](https://github.com/Azure/openapi-diff/blob/master/README.md) for how to install or run tool in details.
Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/diff).
Refer to [Oad Docs](https://github.com/Azure/openapi-diff/tree/master/docs) for detailed description of all oad rules and how-to-fix guidance.

## Linter Validation

Run linter locally:
```
npm install -g autorest
autorest --validation --azure-validator --input-file=<path-to-spec>
or
autorest --validation --azure-validator <path-to-readme>
```
Please see [readme](https://github.com/Azure/azure-openapi-validator/blob/master/README.md) for how to install or run tool in details.
Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/linter).
Refer to [openapi-authoring-automated-guidelines](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md) for detailed description of all lint rules and how-to-fix guidance.

## Avocado

Run avocado locally:

```
npm install -g @azure/avocado
avocado
```

When type avocado in command line, avocado will validate in the current directory.

Note: When running in Swagger PR pipeline, Avocado only report errors with file updates in the PR, but ignore the errors existing in base. However when running Avocado against local directory, it reports all errors existing in the files.

- Run all specs: Clone the repo `azure/azure-rest-api-specs` and run "avocado" in folder `azure/azure-rest-api-specs`.
- Run single service specs: create a folder `specification`. and move your service specs folder in `specification`. run "avocado"

Refer to [Avocado Readme](https://github.com/Azure/avocado/blob/master/README.md) for detailed description of validations and how-to-fix guidance.

Loading

0 comments on commit 4948c75

Please sign in to comment.