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'
|
||||
info:
|
||||
description: OpenFaaS API documentation
|
||||
version: 0.8.2
|
||||
version: 0.8.9
|
||||
title: OpenFaaS API Gateway
|
||||
license:
|
||||
name: MIT
|
||||
basePath: /
|
||||
schemes:
|
||||
- http
|
||||
- https
|
||||
paths:
|
||||
'/system/functions':
|
||||
get:
|
||||
@ -284,13 +283,22 @@ definitions:
|
||||
type: object
|
||||
properties:
|
||||
provider:
|
||||
type: string
|
||||
type: object
|
||||
description: The OpenFaaS Provider
|
||||
properties:
|
||||
provider:
|
||||
type: string
|
||||
example: faas-swarm
|
||||
orchestration:
|
||||
type: string
|
||||
example: swarm
|
||||
version:
|
||||
type: object
|
||||
description: Version of the OpenFaaS Provider
|
||||
properties:
|
||||
commit_message:
|
||||
type: string
|
||||
example: Sample Message
|
||||
sha:
|
||||
type: string
|
||||
example: 7108418d9dd6b329ddff40e7393b3166f8160a88
|
||||
@ -298,13 +306,23 @@ definitions:
|
||||
type: string
|
||||
format: semver
|
||||
example: 0.2.6
|
||||
orchestration:
|
||||
version:
|
||||
type: object
|
||||
description: Version of the Gateway
|
||||
properties:
|
||||
commit_message:
|
||||
type: string
|
||||
example: swarm
|
||||
example: Sample Message
|
||||
sha:
|
||||
type: string
|
||||
example: 7108418d9dd6b329ddff40e7393b3166f8160a88
|
||||
release:
|
||||
type: string
|
||||
format: semver
|
||||
example: 0.8.9
|
||||
required:
|
||||
- provider
|
||||
- version
|
||||
- orchestration
|
||||
DeleteFunctionRequest:
|
||||
type: object
|
||||
properties:
|
||||
@ -345,15 +363,15 @@ definitions:
|
||||
description: Constraints are specific to OpenFaaS Provider
|
||||
example: "node.platform.os == linux"
|
||||
labels:
|
||||
type: string
|
||||
items:
|
||||
type: array
|
||||
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
|
||||
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:
|
||||
type: array
|
||||
items:
|
||||
@ -365,7 +383,7 @@ definitions:
|
||||
description: >-
|
||||
Private registry base64-encoded basic auth (as present in
|
||||
~/.docker/config.json)
|
||||
example: Basic dXNlcjpwYXNzd29yZA==
|
||||
example: dXNlcjpwYXNzd29yZA==
|
||||
limits:
|
||||
type: object
|
||||
properties:
|
||||
|
Reference in New Issue
Block a user