mirror of
https://github.com/openfaas/faas.git
synced 2025-06-22 14:53:25 +00:00
Modified API Docs based on feedback
* Removed "Basic " from example * Removed HTTPS from scheme * Updated Info Object * Fixed Ident Signed-off-by: Simon Pelczer <templum.dev@gmail.com>
This commit is contained in:
committed by
Alex Ellis
parent
4963f39e87
commit
5143917782
@ -1,14 +1,13 @@
|
|||||||
swagger: '2.0'
|
swagger: '2.0'
|
||||||
info:
|
info:
|
||||||
description: OpenFaaS API documentation
|
description: OpenFaaS API documentation
|
||||||
version: 0.8.2
|
version: 0.8.9
|
||||||
title: OpenFaaS API Gateway
|
title: OpenFaaS API Gateway
|
||||||
license:
|
license:
|
||||||
name: MIT
|
name: MIT
|
||||||
basePath: /
|
basePath: /
|
||||||
schemes:
|
schemes:
|
||||||
- http
|
- http
|
||||||
- https
|
|
||||||
paths:
|
paths:
|
||||||
'/system/functions':
|
'/system/functions':
|
||||||
get:
|
get:
|
||||||
@ -284,13 +283,22 @@ definitions:
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
provider:
|
provider:
|
||||||
type: string
|
type: object
|
||||||
description: The OpenFaaS Provider
|
description: The OpenFaaS Provider
|
||||||
|
properties:
|
||||||
|
provider:
|
||||||
|
type: string
|
||||||
example: faas-swarm
|
example: faas-swarm
|
||||||
|
orchestration:
|
||||||
|
type: string
|
||||||
|
example: swarm
|
||||||
version:
|
version:
|
||||||
type: object
|
type: object
|
||||||
description: Version of the OpenFaaS Provider
|
description: Version of the OpenFaaS Provider
|
||||||
properties:
|
properties:
|
||||||
|
commit_message:
|
||||||
|
type: string
|
||||||
|
example: Sample Message
|
||||||
sha:
|
sha:
|
||||||
type: string
|
type: string
|
||||||
example: 7108418d9dd6b329ddff40e7393b3166f8160a88
|
example: 7108418d9dd6b329ddff40e7393b3166f8160a88
|
||||||
@ -298,13 +306,23 @@ definitions:
|
|||||||
type: string
|
type: string
|
||||||
format: semver
|
format: semver
|
||||||
example: 0.2.6
|
example: 0.2.6
|
||||||
orchestration:
|
version:
|
||||||
|
type: object
|
||||||
|
description: Version of the Gateway
|
||||||
|
properties:
|
||||||
|
commit_message:
|
||||||
type: string
|
type: string
|
||||||
example: swarm
|
example: Sample Message
|
||||||
|
sha:
|
||||||
|
type: string
|
||||||
|
example: 7108418d9dd6b329ddff40e7393b3166f8160a88
|
||||||
|
release:
|
||||||
|
type: string
|
||||||
|
format: semver
|
||||||
|
example: 0.8.9
|
||||||
required:
|
required:
|
||||||
- provider
|
- provider
|
||||||
- version
|
- version
|
||||||
- orchestration
|
|
||||||
DeleteFunctionRequest:
|
DeleteFunctionRequest:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -345,15 +363,15 @@ 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:
|
||||||
type: string
|
|
||||||
items:
|
|
||||||
type: array
|
|
||||||
description: An array of labels used by the back-end for making scheduling or routing decisions
|
description: An array of labels used by the back-end for making scheduling or routing decisions
|
||||||
annotations:
|
|
||||||
type: string
|
|
||||||
description: An array of annotations used by the back-end for management, orchestration, events and build tasks
|
|
||||||
items:
|
|
||||||
type: array
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
annotations:
|
||||||
|
description: An array of annotations used by the back-end for management, orchestration, events and build tasks
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
secrets:
|
secrets:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
@ -365,7 +383,7 @@ definitions:
|
|||||||
description: >-
|
description: >-
|
||||||
Private registry base64-encoded basic auth (as present in
|
Private registry base64-encoded basic auth (as present in
|
||||||
~/.docker/config.json)
|
~/.docker/config.json)
|
||||||
example: Basic dXNlcjpwYXNzd29yZA==
|
example: dXNlcjpwYXNzd29yZA==
|
||||||
limits:
|
limits:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
Reference in New Issue
Block a user