Skip to content

Commit

Permalink
Include notification for new directory structure (Azure#1364)
Browse files Browse the repository at this point in the history
* Include notification for new directory structure

Adding description to the new upcoming changes to the repos folder structure

* Update README.md

* Fixed the broken  Directory structure

Fixed the structure

* Updated Tag Value

updated Tag values to "package-2017-03"

I hope this is what you meant cause honestly I don't have a lot of context on the decision or pattern for this value :)

* Added root folder

Added root folder "Specification"
  • Loading branch information
salameer authored Jul 5, 2017
1 parent 0ffdde6 commit 97eb2b1
Showing 1 changed file with 55 additions and 1 deletion.
56 changes: 55 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,64 @@ The structure should appear like so:
└── readme.md
```

## New Directory structure (effective July 10th 2017)

Re-organization is being done to support upcoming profiles work and Data Plane swagger specs. The new structure will appear like below

```bash
.

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
```
### Changing the representation of composite swagger metadata

Currently composite swagger metadata is captured in a .json file. The problem with the current representation is that it does not provide a way to track what versions of swagger specs were used in earlier releases. With the upcoming changes, we will be able to keep track of multiple versions of composition. The metadata will be captured in readme.md file under resource-manager folder. There won’t be a need for .json file. New structure in readme.md file looks like below.
Tag: package-2017-03
These settings apply only when --tag=package-2017-03 is specified on the command line.
input-file:
- Microsoft.Compute/2017-03-30/compute.json
- Microsoft.Compute/2017-03-30/disk.json
- Microsoft.Compute/2017-03-30/runCommands.json
- Microsoft.ContainerService/2017-01-31/containerService.json

Please take a look at this [readme.md](https://github.com/Azure/azure-rest-api-specs/tree/reorg/specification/compute/resource-manager) (Acessible by Azure github org members only) to understand how the complete structure looks like.


## Specs Format
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](https://github.com/Azure/adx-documentation-pr) for more information.

---
_This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments._
_This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments._

0 comments on commit 97eb2b1

Please sign in to comment.