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

Compute update folder structure #19723

Merged
merged 45 commits into from
Aug 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
ddbd65e
update folder structure
Jul 8, 2022
322b6d9
small errors and CI check
Jul 9, 2022
d5af653
Merge branch 'main' into feature/cplat-swaggerRestructure
grizzlytheodore Jul 12, 2022
5617900
Merge branch 'main' into feature/cplat-swaggerRestructure
grizzlytheodore Jul 20, 2022
f705a46
[Language Text] Update swagger titles (#19835)
deyaaeldeen Jul 21, 2022
e644176
Review request for Microsoft.ContainerService to add version 2022-06-…
FumingZhang Jul 21, 2022
3ef4bf9
Update resources.json (#19861)
abatishchev Jul 21, 2022
9ae616c
Pattts/predictive autoscale 20221001 (#19765)
PatrickTseng Jul 21, 2022
7a33b79
[Maps - Render & Spatial Services] add v2022-08-01 (#19520)
gigigoo0 Jul 21, 2022
411d815
update appconfiguration (#19330)
Wzb123456789 Jul 21, 2022
077c9d9
[Hub Generated] Publish private branch 'main' (#19852)
AbhishekKrishna123 Jul 21, 2022
657a108
Merging Dynatrace swagger in stable folder (#19862)
divyansh3131 Jul 21, 2022
1147587
[CDN] Fix customDomains property type in Endpoint (#19788)
t-bzhan Jul 21, 2022
9d67b48
Adding Microsoft.Sql AdvancedThreatProtectionSettings APIs for MI on …
cohen-uriel-ms Jul 21, 2022
0c7b86e
update folders
Jul 21, 2022
9ab027d
[Hub Generated] Review request for Microsoft.KeyVault to add version …
susolank Jul 21, 2022
36ac14c
Add latest StorageMover updates (#19876)
AbhishekKrishna123 Jul 22, 2022
43ca5ba
Update readme.python.md (#19899)
Wzb123456789 Jul 22, 2022
405811c
Moving files from azure-rest-spec-pr to azure-rest-spec repo after ap…
bexxx Jul 22, 2022
bd05dd0
Removed static IP allocation only from examples (#19858)
arpit-gagneja Jul 22, 2022
80e5364
Update securityinsights readme.python (#19903)
Wzb123456789 Jul 22, 2022
f4e7a1c
fix lint errors in Synapse trigger.json (#19660)
yanjungao718 Jul 22, 2022
b640362
put json files into RP folders
Jul 22, 2022
67e0748
update readme
Jul 22, 2022
e5c683e
Merge branch 'feature/cplat-swaggerRestructure' of https://github.com…
Jul 22, 2022
226c70f
Add CONTRIBUTING.md (#19257)
mikekistler Jul 22, 2022
492de00
fix devcenter readme.go.md config (#19906)
Alancere Jul 25, 2022
2b546e9
add annotation for labservices (#19884)
j-zhong-ms Jul 25, 2022
4247c95
add to description of OS state (#19764)
tfitzmac Jul 25, 2022
5bca310
[Hub Generated] Review request for Microsoft.KeyVault to add version …
neeerajaakula Jul 25, 2022
a7480c1
[Microsoft.DeviceUpdate] Adding first stable API version (#19846)
darkoa-msft Jul 25, 2022
163f3ba
Fix broken link (#19688)
roy-work Jul 25, 2022
4c50e5a
add aadObjectId property to kustoPool (#19856)
amitelran Jul 25, 2022
2492a71
Updata securityinsights readme.python (#19917)
Wzb123456789 Jul 25, 2022
574ee06
modify readme.typescripy.md for compute package (#19607)
kazrael2119 Jul 25, 2022
a211ef5
Dev gubalasu frontdoor microsoft.network 2021 06 01 (#19578)
gubalasu Jul 25, 2022
8c22581
Update securityinsights readme.python (#19923)
Wzb123456789 Jul 25, 2022
9ea5a63
sync with changes made to master
Jul 25, 2022
4bd0122
update folder structure
Jul 8, 2022
4d5c94b
small errors and CI check
Jul 9, 2022
79d4154
update folders
Jul 21, 2022
1630332
put json files into RP folders
Jul 22, 2022
7e465d9
update readme
Jul 22, 2022
9998ea2
resolve conflict
Jul 25, 2022
7008521
resolve capitalization and number misplacement accident
Jul 26, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
92 changes: 92 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Contributing

This file provides general guidance for developers that are creating or updating REST API definitions for Azure.

## Table of Contents
<!--
You should regenerate the TOC using the `markdown-toc` node package after making changes to this file.

npx markdown-toc -i --maxdepth 4 CONTRIBUTING.md
-->

<!-- toc -->

- [Reporting problems](#reporting-problems)
- [Avoid Breaking Changes](#avoid-breaking-changes)
- [Design Guidelines](#design-guidelines)
* [Exceptions for consistency within a service](#exceptions-for-consistency-within-a-service)
- [Coding Style](#coding-style)
- [Directory Structure](#directory-structure)
- [Pull Requests](#pull-requests)
- [Pull Request checks](#pull-request-checks)

<!-- tocstop -->

## Reporting problems

If you discover a problem with a REST API document in this repo, feel free to [open an issue](https://github.com/Azure/azure-rest-api-specs/issues/new). But please do not report issues with service behavior / functionality in this repo.

When opening an issue, please clearly describe the problem including which REST API definition is in error and what elements of the definition are incorrect or missing.

## Avoid Breaking Changes

The first rule for Azure REST APIs is to avoid breaking changes in Generally Available (GA'd) APIs. The [Azure Breaking Changes Policy](https://aka.ms/AzBreakingChangesPolicy) is a formal description of what changes are considered breaking changes. This rule trumps adherence to Design Guidelines, Coding Style, etc.

## Design Guidelines

Azure REST APIs should conform to the [Azure REST API Guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md).

There is a [YouTube video series](https://www.youtube.com/watch?v=9Ng00IlBCtw) by Jeffrey Richter that describes the guidelines in detail.

Another resource is the [Considerations for Service Design](https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md), which is an introduction to REST API design mainly for services that are just getting started.

### Exceptions for consistency within a service

There are situations where a service has GA'd their API with design patterns that do not follow our guidelines and it would be a breaking change to adopt the API design in the guidelines.
Because the first rule is to avoid breaking changes and because we want APIs to be consistent within a service, these design patterns are considered the standard for that service and should be followed in all subsequent (non-breaking) versions of that service's REST API.

## Coding Style

REST APIs for Azure should be defined using the [OpenAPI v2](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md) or [Cadl](https://aka.ms/cadl/rpaas-start)format.

The REST API should also adhere to the conventions documented in the [Azure API Style Guide](https://github.com/Azure/azure-api-style-guide/blob/main/openapi-style-guide.md).

You can use the [Spectral linter](https://meta.stoplight.io/docs/spectral/674b27b261c3c-overview) with our [Spectral ruleset](https://github.com/Azure/azure-api-style-guide#how-to-use-the-spectral-ruleset) to check conformance with OpenAPI v2 and the Style Guide.

## Directory Structure

See the [README.md](./README.md) for a description of the directory structure to use when adding files to this repo.

## Pull Requests

If you want to contribute to the repository, follow these steps:
1. Fork the repository and create a new branch for your changes.
2. If you are introducing a new api-version, create a new directory for that api-version and copy all the files from the previous version into the new directory. Make this the very first commit in your branch and then make your changes in subsequent commits.
3. Use the [linting tools](#coding-style) to check your changes for compliance with the OpenAPI v2 standard, the Azure REST API Guidelines and that Azure API Style Guide.
4. Push the changes to the branch in your fork until the branch is ready to be integrated.
5. Rebase your branch if needed to incorporate any changes to **main** and submit a pull request to the **main** branch using either the "control plane" or "data plane" PR template -- the main PR template lets you select which one.
5. Resolve any issues flagged by the [Pull Request checks](#pull-request-checks).
6. Contact the ARM API Review board or Azure API Stewardship team to request PR review.

Microsoft employees can try out the experience at [OpenAPI Hub](https://aka.ms/openapihub) for [adding a new API version using OpenAPI Hub](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version).

## Pull Request checks

Every PR in this repo will go through a series of PR checks, including:

- Breaking Changes - checks for incompatible changes in an existing api-version
- Breaking Changes (Cross-Version) - checks for changes in a new api-version that are incompatible with prior versions
- LintDiff - checks the new or changed portions of the API for compliance with the Azure REST API Guidelines and API Style Guide
- Avocado - checks that new or changed files comply with the directory structure convention for this repo.
- Model Validation -
- Semantic Validation -
- LintRPaaS -
- ApiReadiness -
- PoliCheck -
- CredScan -
- SpellCheck -
- PrettierCheck -
- SDK Breaking Change -

When any of these PR checks fails it will post a comment to the PR with links to information on how to resolve the problem.
There is also the [CI Fix Guide](https://aka.ms/ci-fix) that describes how to fix common PR check failures.
15 changes: 14 additions & 1 deletion custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ appteststorage
appxmanifest
Appxmanifest
ARGBARGB
argmax
ARIN
Arima
Arimax
Expand Down Expand Up @@ -539,6 +540,7 @@ dataversion
datawarehouse
datetimeoffset
datetimes
davinci
Dbinstance
DBFS
DCOS
Expand Down Expand Up @@ -685,6 +687,7 @@ enablelog
enablement
enablescheduling
ename
endoftext
endpointkeys
endpointname
endswith
Expand Down Expand Up @@ -779,6 +782,8 @@ fileuploadout
fileurl
findsimilars
findsquare
finetune
finetunes
firmwares
Flexera
Flowlet
Expand Down Expand Up @@ -938,6 +943,7 @@ hybriddatamanager
Hyperdrive
Hypernet
hyperparameters
hyperparams
Hyperscale
hyperv
hypervcollectors
Expand Down Expand Up @@ -1175,8 +1181,11 @@ managedidentity
loganalytics
loggerid
logio
logit
logits
Logix
lognormal
logprobs
logprofiles
loguniform
Logz
Expand Down Expand Up @@ -1389,6 +1398,7 @@ newrelapp
newssearch
Newtonsoft
nextlink
NFSauto
Ngfw
NICs
nillable
Expand Down Expand Up @@ -1469,6 +1479,7 @@ onpremises
ONVIF
oobe
Oozie
openai
openapi
openbsd
opencode
Expand All @@ -1490,6 +1501,7 @@ Optimisers
optionalbody
optmem
Optmem
organisation
originpath
Orignal
osdisk
Expand Down Expand Up @@ -2680,4 +2692,5 @@ Sirmauri
Skolt
Thangmi
Tuvan
Uyghur
Uyghur
Paramter
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"swagger": "2.0",
"info": {
"title": "Microsoft Cognitive Language Service",
"title": "Microsoft Cognitive Language Service - Text Analysis",
"description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.0",
"version": "2022-07-01-preview"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,49 @@
## Python

These settings apply only when `--track2` is specified on the command line.
These settings apply only when `--python` is specified on the command line.

``` yaml $(python)
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
package-name: azure-mgmt-appconfiguration
namespace: azure.mgmt.appconfiguration
package-version: 1.0.0b1
no-namespace-folders: true
```

### Python multi-api

Generate all API versions currently shipped for this package

```yaml $(python)
clear-output-folder: true
multiapi: true
batch:
- tag: package-2022-05-01
- tag: package-2022-03-01-preview
- multiapiscript: true
```

``` yaml $(python)
no-namespace-folders: true
output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration
``` yaml $(multiapiscript)
output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/
perform-load: false
```

### Tag: package-2022-05-01 and python

These settings apply only when `--tag=package-2022-05-01 --python` is specified on the command line.
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.

``` yaml $(tag) == 'package-2022-05-01' && $(python)
namespace: azure.mgmt.appconfiguration.v2022_05_01
output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/v2022_05_01
```

### Tag: package-2022-03-01-preview and python

These settings apply only when `--tag=package-2022-03-01-preview --python` is specified on the command line.
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.

``` yaml $(tag) == 'package-2022-03-01-preview' && $(python)
namespace: azure.mgmt.appconfiguration.v2022_03_01_preview
output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/v2022_03_01_preview
```
Original file line number Diff line number Diff line change
Expand Up @@ -2657,8 +2657,11 @@
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/CustomDomain"
}
"$ref": "#/definitions/DeepCreatedCustomDomain"
},
"x-ms-identifiers": [
"name"
]
},
"resourceState": {
"description": "Resource status of the endpoint.",
Expand Down Expand Up @@ -5484,6 +5487,40 @@
}
}
},
"DeepCreatedCustomDomain": {
"description": "Custom domains created on the CDN endpoint.",
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"description": "Custom domain name.",
"type": "string"
},
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/DeepCreatedCustomDomainProperties"
}
}
},
"DeepCreatedCustomDomainProperties": {
"description": "Properties of the custom domain created on the CDN endpoint.",
"type": "object",
"required": [
"hostName"
],
"properties": {
"hostName": {
"description": "The host name of the custom domain. Must be a domain name.",
"type": "string"
},
"validationData": {
"description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.",
"type": "string"
}
}
},
"CustomDomain": {
"description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.",
"type": "object",
Expand Down
Loading