Skip to content

Commit

Permalink
Josefree doc update (Azure#16457)
Browse files Browse the repository at this point in the history
* Create Sample Directory Structure for Swagger

* Delete Sample Directory Structure for Swagger

* Create Sample Directory Structure for Swagger

* Update Getting started with OpenAPI specifications.md

* Delete Sample Directory Structure for Swagger

will reuse this wiki https://github.com/Azure/azure-rest-api-specs/wiki#directory-structure, instead of creating a new one.

* Update Getting started with OpenAPI specifications.md

reuse this wiki for sample directory https://github.com/Azure/azure-rest-api-specs/wiki#directory-structure
  • Loading branch information
josefree authored Oct 22, 2021
1 parent f7e5dc7 commit 4aebac1
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions documentation/Getting started with OpenAPI specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ Currently, we only support `OpenAPI Specification 2.0` or `Swagger V2.0`.

### Helpful Resources
* **[`Understanding the GitHub flow`](https://guides.github.com/introduction/flow/)**
* **[`Microsoft REST-API guidelines`](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md)**
* **[`Microsoft REST-API guidelines`](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md)**]
* **[`Resource Provider Guidelines`](https://aka.ms/rpguidelines)**
* **[`Sample directory structure for swagger`](https://github.com/Azure/azure-rest-api-specs/wiki#directory-structure)**
* **[`Structure of a Swagger specification`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/creating-swagger.md)**
* **[`Sample Swagger specification`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json)**
* **[`Sample Readme.md`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/samplereadme.md)**
Expand All @@ -19,5 +21,5 @@ Currently, we only support `OpenAPI Specification 2.0` or `Swagger V2.0`.
* [`Validation checks through automated tools`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md)
* [`Validation checks done manually`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-manual-guidelines.md)
* [`OAV Validation checks`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md)
* **[`Breaking Changes guidelines`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Breaking%20changes%20guidelines.md)**
* **[`Breaking Changes guidelines`](https://aka.ms/AzBreakingChangesPolicy)**
* **[`x-ms-examples`](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/x-ms-examples.md)**

0 comments on commit 4aebac1

Please sign in to comment.