mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Add intro to swagger.yaml to explain what it's for
Signed-off-by: Ben Firshman <ben@firshman.co.uk>
This commit is contained in:
parent
d9b109b807
commit
be52738a2c
1 changed files with 11 additions and 0 deletions
|
@ -1,3 +1,14 @@
|
|||
# A Swagger 2.0 (a.k.a. OpenAPI) definition of the Engine API.
|
||||
#
|
||||
# This is used for generating API documentation and the types used by the
|
||||
# client/server. See api/README.md for more information.
|
||||
#
|
||||
# Some style notes:
|
||||
# - This file is used by ReDoc, which allows GitHub Flavored Markdown in
|
||||
# descriptions.
|
||||
# - There is no maximum line length, for ease of editing and pretty diffs.
|
||||
# - operationIds are in the format "NounVerb", with a singular noun.
|
||||
|
||||
swagger: "2.0"
|
||||
schemes:
|
||||
- "http"
|
||||
|
|
Loading…
Add table
Reference in a new issue