Skip to content

Commit c1ac0ae

Browse files
committed
Merge pull request #2 from Azure/chore/restructure
Restructure folder naming scheme and update the readme
2 parents 6022e27 + 21365db commit c1ac0ae

14 files changed

Lines changed: 37 additions & 16 deletions

File tree

Microsoft.Compute/README.md

Whitespace-only changes.

Microsoft.Network/.keep

Whitespace-only changes.

Microsoft.Resources/.keep

Whitespace-only changes.

Microsoft.Storage/.keep

Whitespace-only changes.

Microsoft.Web/.keep

Whitespace-only changes.

README.md

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,44 @@ This repository is the canonical source for REST API specifications for Microsof
55
## Directory Structure
66

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

1313
The structure should appear like so:
1414
```bash
1515
.
16-
├── Microsoft.Compute
17-
│   ├── 2014-01-01
18-
│   │   └── swagger
19-
│   │   ├── service.json
20-
│   │   └── service.yaml
21-
│   ├── 2014-12-31
22-
│   │   └── swagger
23-
│   └── README.md
24-
├── Microsoft.Network
25-
├── Microsoft.Resources
26-
├── Microsoft.Storage
27-
├── Microsoft.Web
28-
└── README.md
16+
├── arm-authorization
17+
│   └── 2015-01-01
18+
│   └── swagger
19+
│   └── authorization.json
20+
├── arm-compute
21+
│   └── 2015-06-15
22+
│   └── swagger
23+
│   └── service.json
24+
├── arm-features
25+
│   └── 2014-08-01-preview
26+
│   └── swagger
27+
│   └── features.json
28+
├── arm-network
29+
│   └── 2015-05-01-preview
30+
│   └── swagger
31+
│   └── service.json
32+
├── arm-resources
33+
│   └── 2014-04-01-preview
34+
│   └── swagger
35+
│   └── service.json
36+
├── arm-storage
37+
│   └── 2015-05-01-preview
38+
│   └── swagger
39+
│   └── service.json
40+
├── arm-subscriptions
41+
│   └── 2014-04-01-preview
42+
│   └── swagger
43+
│   └── service.json
44+
├── arm-web
45+
└── readme.md
2946
```
3047

3148
At this point, the specifications are expected to be in swagger format.
@@ -47,3 +64,7 @@ Always write a clear log message for your commits. One-line messages are fine fo
4764
$ git commit -m "A brief summary of the commit
4865
>
4966
> A paragraph describing what changed and its impact."
67+
68+
Please be kind with your pull requests and ensure you keeping them as focused and cohesive as possible. Keep your pull
69+
request free of merge commits, code review fixes and anything that may take away from the essence of your contribution.
70+
Use the git tools you have available to you, such as amend, rebase, etc.

Microsoft.Resources.Authorization/2015-01-01/swagger/service.json renamed to arm-authorization/2015-01-01/swagger/authorization.json

File renamed without changes.
File renamed without changes.

Microsoft.Resources.Feature/2014-08-01-preview/swagger/service.json renamed to arm-features/2014-08-01-preview/swagger/features.json

File renamed without changes.

Microsoft.Network/2015-05-01-preview/swagger/service.json renamed to arm-network/2015-05-01-preview/swagger/network.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4426,4 +4426,4 @@
44264426
"description": "Client Api Version."
44274427
}
44284428
}
4429-
}
4429+
}

0 commit comments

Comments
 (0)