From 5ae0133ebee7c182a6a7be7c27f870520d0b21f6 Mon Sep 17 00:00:00 2001 From: David Justice Date: Fri, 17 Jul 2015 12:29:47 -0700 Subject: [PATCH 1/2] restructure naming so it's a little more friendly --- Microsoft.Compute/README.md | 0 Microsoft.Network/.keep | 0 Microsoft.Resources/.keep | 0 Microsoft.Storage/.keep | 0 Microsoft.Web/.keep | 0 README.md | 47 +++++++++++++------ .../2015-01-01/swagger/authorization.json | 0 .../2015-06-15/swagger/compute.json | 0 .../2014-08-01-preview/swagger/features.json | 0 .../2015-05-01-preview/swagger/network.json | 2 +- .../2014-04-01-preview/swagger/resources.json | 0 .../2015-05-01-preview/swagger/storage.json | 0 .../swagger/subscriptions.json | 0 {Microsoft.Compute => arm-web}/.keep | 0 14 files changed, 33 insertions(+), 16 deletions(-) delete mode 100644 Microsoft.Compute/README.md delete mode 100644 Microsoft.Network/.keep delete mode 100644 Microsoft.Resources/.keep delete mode 100644 Microsoft.Storage/.keep delete mode 100644 Microsoft.Web/.keep rename Microsoft.Resources.Authorization/2015-01-01/swagger/service.json => arm-authorization/2015-01-01/swagger/authorization.json (100%) rename Microsoft.Compute/2015-06-15/swagger/service.json => arm-compute/2015-06-15/swagger/compute.json (100%) rename Microsoft.Resources.Feature/2014-08-01-preview/swagger/service.json => arm-features/2014-08-01-preview/swagger/features.json (100%) rename Microsoft.Network/2015-05-01-preview/swagger/service.json => arm-network/2015-05-01-preview/swagger/network.json (99%) rename Microsoft.Resources/2014-04-01-preview/swagger/service.json => arm-resources/2014-04-01-preview/swagger/resources.json (100%) rename Microsoft.Storage/2015-05-01-preview/swagger/service.json => arm-storage/2015-05-01-preview/swagger/storage.json (100%) rename Microsoft.Subscriptions/2014-04-01-preview/swagger/service.json => arm-subscriptions/2014-04-01-preview/swagger/subscriptions.json (100%) rename {Microsoft.Compute => arm-web}/.keep (100%) diff --git a/Microsoft.Compute/README.md b/Microsoft.Compute/README.md deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/Microsoft.Network/.keep b/Microsoft.Network/.keep deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/Microsoft.Resources/.keep b/Microsoft.Resources/.keep deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/Microsoft.Storage/.keep b/Microsoft.Storage/.keep deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/Microsoft.Web/.keep b/Microsoft.Web/.keep deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/README.md b/README.md index 9a166a8f2e66..2634980463f7 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/Microsoft.Resources.Authorization/2015-01-01/swagger/service.json b/arm-authorization/2015-01-01/swagger/authorization.json similarity index 100% rename from Microsoft.Resources.Authorization/2015-01-01/swagger/service.json rename to arm-authorization/2015-01-01/swagger/authorization.json diff --git a/Microsoft.Compute/2015-06-15/swagger/service.json b/arm-compute/2015-06-15/swagger/compute.json similarity index 100% rename from Microsoft.Compute/2015-06-15/swagger/service.json rename to arm-compute/2015-06-15/swagger/compute.json diff --git a/Microsoft.Resources.Feature/2014-08-01-preview/swagger/service.json b/arm-features/2014-08-01-preview/swagger/features.json similarity index 100% rename from Microsoft.Resources.Feature/2014-08-01-preview/swagger/service.json rename to arm-features/2014-08-01-preview/swagger/features.json diff --git a/Microsoft.Network/2015-05-01-preview/swagger/service.json b/arm-network/2015-05-01-preview/swagger/network.json similarity index 99% rename from Microsoft.Network/2015-05-01-preview/swagger/service.json rename to arm-network/2015-05-01-preview/swagger/network.json index 34d264896ce9..fd57ab71ef62 100644 --- a/Microsoft.Network/2015-05-01-preview/swagger/service.json +++ b/arm-network/2015-05-01-preview/swagger/network.json @@ -4426,4 +4426,4 @@ "description": "Client Api Version." } } -} \ No newline at end of file +} diff --git a/Microsoft.Resources/2014-04-01-preview/swagger/service.json b/arm-resources/2014-04-01-preview/swagger/resources.json similarity index 100% rename from Microsoft.Resources/2014-04-01-preview/swagger/service.json rename to arm-resources/2014-04-01-preview/swagger/resources.json diff --git a/Microsoft.Storage/2015-05-01-preview/swagger/service.json b/arm-storage/2015-05-01-preview/swagger/storage.json similarity index 100% rename from Microsoft.Storage/2015-05-01-preview/swagger/service.json rename to arm-storage/2015-05-01-preview/swagger/storage.json diff --git a/Microsoft.Subscriptions/2014-04-01-preview/swagger/service.json b/arm-subscriptions/2014-04-01-preview/swagger/subscriptions.json similarity index 100% rename from Microsoft.Subscriptions/2014-04-01-preview/swagger/service.json rename to arm-subscriptions/2014-04-01-preview/swagger/subscriptions.json diff --git a/Microsoft.Compute/.keep b/arm-web/.keep similarity index 100% rename from Microsoft.Compute/.keep rename to arm-web/.keep From 21365db041ed84e5410d5df5211bd5d4d21ed62b Mon Sep 17 00:00:00 2001 From: David Justice Date: Fri, 17 Jul 2015 12:43:35 -0700 Subject: [PATCH 2/2] update readme with better instructions for contribution --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 2634980463f7..36b964212f47 100644 --- a/README.md +++ b/README.md @@ -64,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.