Skip to content

Latest commit

 

History

History
94 lines (71 loc) · 5.15 KB

README.md

File metadata and controls

94 lines (71 loc) · 5.15 KB
Raw

Repo Status

Azure REST API Specifications

Description

This repository is the canonical source for REST API specifications for Microsoft Azure.

News

While you're away for the holiday season, we're going to be making a few improvements to the Azure REST API Specs repository:

  • We will stop merging PRs until the new year starting on 6:00 p.m. December 20th, 2017.
  • Starting on December 21st, 2017, we will be restoring master as the default branch for this repository.
    • All open PRs will automatically be updated to target master instead of current.
    • We will stop accepting contributions to the current branch.
  • On December 21st, 2017, we will merge a refactoring of this repository where we introduce preview and stable directories to differentiate Swaggers and services that are ready for General Availability and those that are not yet.
  • Beginning December 21st, 2017, the master branch in the private repository will become a read-only copy of the master branch in the public repository.

For more information about this project, please see our wiki: December 2017 Refactoring

Basics

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.

Getting started

Directory Structure

The structure of the directory should strictly follow these rules:

  1. 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.

  2. Specification: This folder the is root folder for all Specs (Management and Dataplane) related docs.

  3. Folders - each RP will have a separate folder

  4. '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

  5. 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.

  6. 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.

  7. Notes:

    • 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

Next steps

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.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.