Skip to content

Commit

Permalink
initial commit with usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
devigned committed Jul 15, 2015
0 parents commit 8c42e63
Show file tree
Hide file tree
Showing 7 changed files with 102 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
#### linux gitignore

*~

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*


#### win gitignore

# Windows image file caches
Thumbs.db
ehthumbs.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

# Windows shortcuts
*.lnk


#### osx gitignore

.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
Empty file added Microsoft.Compute/.keep
Empty file.
Empty file added Microsoft.Network/.keep
Empty file.
Empty file added Microsoft.Resources/.keep
Empty file.
Empty file added Microsoft.Storage/.keep
Empty file.
Empty file added Microsoft.Web/.keep
Empty file.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Azure REST API Specifications

This repository is the canonical source for REST API specifications for Microsoft Azure.

## 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 third level must be the format of the specification
- The forth level must be the specifications

The structure should appear like so:
/Resource.Provider
/2014-01-01
/swagger
/service.json
/service.yaml
/2014-12-31
/swagger
/service.json
/service.yaml

At this point, the specifications are expected to be in swagger format.

## Generating Code from Specifications

If you are interested in generating code from these specifications, please check out [AutoRest](https://github.com/azure/autorest). There you will find the code generator as well as instructions on how to use it.

## How to Contribute

Please contribute to services you know and love. The curation of these specifications will ensure that we have great documentation and even better client library support for our Azure Services. If you have any questions, please reach out to the autoresteng dl.

### Submitting changes

Please send a [GitHub Pull Request to Azure REST API Specs](https://github.com/azure/azure-rest-api-specs/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). When you send a pull request, we will love you forever if you include additions to the documentation for your given service. We can always use more documentation and beautiful markdown. Please follow make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."

0 comments on commit 8c42e63

Please sign in to comment.