Fixed Route definition in swagger doc. (#405)

* Fixed Route definition in swagger doc.

* Changed swagger URL to petstore so we don't have to maintain it in swaggerhub and github anymore.
This commit is contained in:
Travis Reeder
2016-12-07 11:33:34 -08:00
committed by C Cirello
parent ca4c7ac2bf
commit e172a838c2
2 changed files with 45 additions and 46 deletions

View File

@@ -13,7 +13,7 @@ If you are a developer using IronFunctions through the API, this section is for
* [Function file (func.yaml)](function-file.md) * [Function file (func.yaml)](function-file.md)
* [Packaging functions](packaging.md) * [Packaging functions](packaging.md)
* [Open Function Format](function-format.md) * [Open Function Format](function-format.md)
* [API Reference](https://app.swaggerhub.com/api/iron/functions/) * [API Reference](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/iron-io/functions/master/docs/swagger.yml)
## For Operators ## For Operators

View File

@@ -6,7 +6,7 @@ swagger: '2.0'
info: info:
title: IronFunctions title: IronFunctions
description: The open source serverless platform. description: The open source serverless platform.
version: "0.1.23" version: "0.1.24"
# the domain of the service # the domain of the service
host: "127.0.0.1:8080" host: "127.0.0.1:8080"
# array of all schemes that your API supports # array of all schemes that your API supports
@@ -316,51 +316,50 @@ paths:
definitions: definitions:
Route: Route:
allOf: type: object
- type: object properties:
properties: path:
path: type: string
description: URL path that will be matched to this route
readOnly: true
image:
description: Name of Docker image to use in this route. You should include the image tag, which should be a version number, to be more accurate. Can be overridden on a per route basis with route.image.
type: string
headers:
type: object
description: Map of http headers that will be sent with the response
additionalProperties:
type: array
items:
type: string type: string
description: URL path that will be matched to this route memory:
readOnly: true type: integer
image: format: int64
description: Name of Docker image to use in this route. You should include the image tag, which should be a version number, to be more accurate. Can be overridden on a per route basis with route.image. description: Max usable memory for this route (MiB).
type: string type:
headers: enum:
type: object - sync
description: Map of http headers that will be sent with the response - async
additionalProperties: description: Route type
type: array format:
items: enum:
type: string - default
memory: - http
type: integer - json
format: int64 description: Payload format sent into function.
description: Max usable memory for this route (MiB). max_concurrency:
type: type: integer
enum: format: int32
- sync description: Maximum number of hot containers concurrency
- async config:
description: Route type type: object
format: description: Route configuration - overrides application configuration
enum: additionalProperties:
- default type: string
- http timeout:
- json type: integer
description: Payload format sent into function. default: 60
max_concurrency: description: Timeout for executions of this route. Value in Seconds
type: integer
format: int32
description: Maximum number of hot containers concurrency
config:
type: object
description: Route configuration - overrides application configuration
additionalProperties:
type: string
timeout:
type: integer
default: 60
description: Timeout for executions of this route. Value in Seconds
App: App:
type: object type: object