Azure REST API Specifications
This repository is the canonical source for REST API specifications for Microsoft Azure.
If you're a spec author looking for information about all of of the repositories and steps in the pipeline, go to the adx-documentation-pr repository. Make sure to join the Github Azure organization to get access to that repo.
- Our Contribution guidelines walks you through the process of contributing to this repository.
- The /documentation folder contains reference documentation for all aspects of Swagger and our recommended patterns. Start with the Creating Swagger page.
The structure of the directory should strictly follow these rules:
Profile: The profile holder contains the profiles' definition MD files. these files will contain information and references to the snapshots of the RPs' Resource types or Dataplane API versions that represent a specific profile.
Specification: This folder the is root folder for all Specs (Management and Dataplane) related docs.
Folders - each RP will have a seperate folder
'resource-manager' and 'data-plane' Folders: the RPs can put specs in one of two categories:
resource-manager(for ARM resources) and
data-plane(for everything else) . The autorest configuration file (
readme.md) for the RP should be inside this folder
API versions: this folder will be the direct child of the category folder. there will be one such folder per resource type or dataplane service version. This folder will contain the OpenAPI validation Specs (Swaggers previously) and the examples folder.
Examples: the example folder will contain the x-ms-examples files. it will reside under the APIs or Resources' version folders as different APIs or Resource types version can have different examples.
- folder names should be singular (ie, 'profile' not 'profiles' ) -- this removes ambiguity for some non-english speakers.
- generic folder names should be lower-case
- proper-name/product name/namespace folders can be PascalCased (ie, "KeyVault")
- files are whatever case you think is good for your soul.
The structure should appear like so:
. \---specification | +---automation | | \---resource-manager | | \---Microsoft.Automation | | \---2015-10-31 | | \---examples | +---batch | | +---data-plane | | | \---Microsoft.Batch | | | +---2015-12-01.2.2 | | | +---2016-02-01.3.0 | | | +---2016-07-01.3.1 | | | +---2017-01-01.4.0 | | | | \---examples | | | \---2017-05-01.5.0 | | \---resource-manager | | \---Microsoft.Batch | | +---2015-12-01 | | +---2017-01-01 | | | \---examples | | \---2017-05-01 | | \---examples | +---billing | \---resource-manager | \---Microsoft.Billing | +---2017-02-27-preview | | \---examples | \---2017-04-24-preview | \---examples \--- readme.md
Currently, the specifications are expected to be in Swagger JSON format
The next step in the process after a spec is completed is to generate SDKs and API reference documentation. Go to the Azure Developer Experience guide for more information.