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

Restructure folder naming scheme and update the readme #2

Merged
merged 2 commits into from
Jul 17, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file removed Microsoft.Compute/README.md
Empty file.
Empty file removed Microsoft.Network/.keep
Empty file.
Empty file removed Microsoft.Resources/.keep
Empty file.
Empty file removed Microsoft.Storage/.keep
Empty file.
Empty file removed Microsoft.Web/.keep
Empty file.
51 changes: 36 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,44 @@ This repository is the canonical source for REST API specifications for Microsof
## Directory Structure

The structure of the directory should strictly follow these rules:
- The top level folder must be the resource provider name
- The second level must be the API versions for the resource provider
- The top level folder must be the service name
- The second level must be the API versions
- The third level must be the format of the specification
- The forth level must be the specifications

The structure should appear like so:
```bash
.
├── Microsoft.Compute
│   ├── 2014-01-01
│   │   └── swagger
│   │   ├── service.json
│   │   └── service.yaml
│   ├── 2014-12-31
│   │   └── swagger
│   └── README.md
├── Microsoft.Network
├── Microsoft.Resources
├── Microsoft.Storage
├── Microsoft.Web
└── README.md
├── arm-authorization
│   └── 2015-01-01
│   └── swagger
│   └── authorization.json
├── arm-compute
│   └── 2015-06-15
│   └── swagger
│   └── service.json
├── arm-features
│   └── 2014-08-01-preview
│   └── swagger
│   └── features.json
├── arm-network
│   └── 2015-05-01-preview
│   └── swagger
│   └── service.json
├── arm-resources
│   └── 2014-04-01-preview
│   └── swagger
│   └── service.json
├── arm-storage
│   └── 2015-05-01-preview
│   └── swagger
│   └── service.json
├── arm-subscriptions
│   └── 2014-04-01-preview
│   └── swagger
│   └── service.json
├── arm-web
└── readme.md
```

At this point, the specifications are expected to be in swagger format.
Expand All @@ -47,3 +64,7 @@ Always write a clear log message for your commits. One-line messages are fine fo
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."

Please be kind with your pull requests and ensure you keeping them as focused and cohesive as possible. Keep your pull
request free of merge commits, code review fixes and anything that may take away from the essence of your contribution.
Use the git tools you have available to you, such as amend, rebase, etc.
Original file line number Diff line number Diff line change
Expand Up @@ -4426,4 +4426,4 @@
"description": "Client Api Version."
}
}
}
}
File renamed without changes.