faas-rs/faas
1
0
Fork 0
mirror of https://github.com/openfaas/faas.git synced 2025-06-14 03:06:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating the Swagger to be more accurate:

Browse Source 
- Fixed annotations and labels type and added examples
- Added the readOnlyRootFilesystem bool

Signed-off-by: Andrew Cornies <acornies@gmail.com>
This commit is contained in:
Andrew Cornies 2019-01-25 16:23:19 -05:00 committed by Alex Ellis
parent 6ee07a7ba9
commit d59f4d87cf
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
api-docs/swagger.yml
View File

@ -444,15 +444,20 @@ definitions:
description: Constraints are specific to OpenFaaS Provider description: Constraints are specific to OpenFaaS Provider
example: "node.platform.os == linux" example: "node.platform.os == linux"
labels: labels:
description: An array of labels used by the back-end for making scheduling or routing decisions description: A dictionary/hashmap used by the back-end for making scheduling or routing decisions
type: array type: object
items: additionalProperties:
type: string type: string
example:
foo: bar
annotations: annotations:
description: An array of annotations used by the back-end for management, orchestration, events and build tasks description: A dictionary/hashmap of annotations used by the back-end for management, orchestration, events and build tasks
type: array type: object
items: additionalProperties:
type: string type: string
example:
topics: awesome-kafka-topic
foo: bar
secrets: secrets:
type: array type: array
items: items:
@ -483,6 +488,9 @@ definitions:
cpu: cpu:
type: string type: string
example: "0.01" example: "0.01"
readOnlyRootFilesystem:
type: boolean
description: Removes write-access from the root filesystem
required: required:
- service - service
- image - image
@ -518,13 +526,20 @@ definitions:
type: string type: string
example: node main.js example: node main.js
labels: labels:
description: A dictionary/hashmap used by the back-end for making scheduling or routing decisions
type: object type: object
additionalProperties: additionalProperties:
type: string type: string
example:
foo: bar
annotations: annotations:
description: A dictionary/hashmap of annotations used by the back-end for management, orchestration, events and build tasks
type: object type: object
additionalProperties: additionalProperties:
type: string type: string
example:
topics: awesome-kafka-topic
foo: bar
required: required:
- name - name
- image - image