OpenApi
View spec in html.
openapi: 3.0.0
info:
version: 'v.0.0.4'
title: 'luna-lambda API'
description: |
'VisionLabs luna-lambda' is service intended for manage luna user lambdas.
Luna-user-lambda represents separate service which can process user requests using code created by user.
For information about lambda representation and requirements - see development manual.
components:
headers:
application_json:
schema:
type: string
enum:
- application/json
required: true
description: The content type of the response body.
luna_request_id:
schema:
type: string
format: timestamp,uuid
example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a
pattern: ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
description: request id. Helps to uniquely identify messages that correspond to particular requests, in system logs.
required: true
docs_content_type:
schema:
type: string
enum:
- application/x-yaml
- text/html
required: true
description: The content type of the response body.
text_html:
schema:
type: string
enum:
- text/html
required: true
description: The content type of the response body.
config_accept_content_type:
schema:
type: string
enum:
- application/json
- text/plain
required: false
description: The content type of the response body.
parameters:
application_json_content:
in: header
name: Content-Type
schema:
type: string
enum:
- application/json
description: The request content type header.
application_multipart_content:
in: header
name: Content-Type
schema:
type: string
enum:
- multipart/form-data
description: The request content type header.
required: true
luna_request_id:
in: header
schema:
type: string
format: timestamp,uuid
example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a
pattern: ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
description: |
external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs.
If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
name: Luna-Request-Id
account_id:
in: query
name: account_id
schema:
$ref: '#/components/schemas/account_id'
description: luna account id
example: '8950722f-3fd4-4223-b48f-03f95f0e8dfb'
header_account_id:
in: header
name: Luna-Account-Id
schema:
$ref: '#/components/schemas/account_id'
description: luna account id
example: '8950722f-3fd4-4223-b48f-03f95f0e8dfb'
required: true
accept_docs_handler:
in: header
name: Accept
schema:
$ref: '#/components/schemas/accept_docs_handler'
required: true
description: acceptable type of receiving data
Accept:
in: header
name: Accept
schema:
type: string
enum:
- application/json
description: Preferred response content type
accept_config_handler:
in: header
name: Accept
schema:
type: string
enum:
- application/json
- text/plain
description: One of application/json, text/plain
required: false
description: acceptable type of receiving data
include_luna_services:
in: query
name: include_luna_services
schema:
type: integer
enum: [0, 1]
default: 0
description: Whether to perform healthchecks for dependent luna services.
create_time__lt:
in: query
name: create_time__lt
schema:
$ref: '#/components/schemas/time'
description: upper bound for object create_time.
example: "2018-08-11T09:11:41.674Z"
create_time__gte:
in: query
name: create_time__gte
schema:
$ref: '#/components/schemas/time'
description: lower included bound for object create_time.
example: "2018-08-11T09:11:41.674Z"
tail_lines:
in: query
name: tail_lines
schema:
type: integer
minimum: 0
maximum: 4294967296
description: number of strings what will be return.
page:
in: query
name: page
schema:
type: integer
minimum: 1
default: 1
description: a page number.
page_size:
in: query
name: page_size
schema:
type: integer
minimum: 1
maximum: 100
default: 10
description: the number of items on page.
lambda_type:
in: query
name: lambda_type
schema:
type: string
enum: [ standalone, handlers ]
description: Lambda type.
lambda_name:
in: query
name: lambda_name
schema:
type: string
description: Find all objects with `lambda_name` similar to this parameter. You can specify only part of the `lambda_name` value for this filter.
schemas:
error:
type: object
properties:
error_code:
type: integer
description: error code.
desc:
type: string
description: short error description.
detail:
type: string
description: error details.
link:
type: string
description: link to the documentation website with the error description.
required: [error_code, detail, desc, link]
example:
error_code: 1
detail: internal server error
desc: internal server error
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-1"
int_version:
type: integer
minimum: 0
accept_docs_handler:
type: string
enum:
- application/x-yaml
- text/html
description: One of application/x-yaml, text/html
version:
type: object
properties:
Version:
type: object
properties:
api:
allOf:
- $ref: '#/components/schemas/int_version'
description: an api version of service.
major:
allOf:
- $ref: '#/components/schemas/int_version'
description: a major version of service.
minor:
allOf:
- $ref: '#/components/schemas/int_version'
description: a minor version of service.
patch:
allOf:
- $ref: '#/components/schemas/int_version'
description: a patch version of service.
required: [ api, major, minor, patch ]
required: [ Version ]
example:
Version:
api: 1
major: 0
minor: 0
patch: 0
time:
type: string
format: date-time
example: "2018-08-11T09:11:41.674Z"
description: time in format RFC 3339
uuid:
type: string
format: uuid
pattern: '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$'
example: "557d54ec-29ad-4f3c-93b4-c9092ef12515"
account_id:
allOf:
- $ref: '#/components/schemas/uuid'
- example: 0468ca85-f6ca-4841-b30c-5ccc26b6f397
description: id of the luna account.
health_ok:
description: successful healthcheck execution info
type: object
properties:
execution_time:
type: number
example: 0.123
description: request execution time in seconds
required: [ execution_time ]
health_errors:
type: object
properties:
errors:
description: failed healthcheck execution info
type: array
items:
type: object
properties:
component:
description: component name
type: string
error:
allOf:
- description: healthcheck error
- $ref: '#/components/schemas/error'
status:
description: component health status
type: integer
enum: [ 0, 1 ]
required: [ component, error, status ]
required: [ errors ]
example:
errors:
- component: lambda_db
error:
error_code: 10017
desc: Database error
detail: Database connection timeout error
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-10017"
status: 0
lambda_id_response:
type: object
properties:
lambda_id:
allOf:
- $ref: '#/components/schemas/uuid'
- example: 0468ca85-f6ca-4841-b30c-5ccc26b6f397
- description: lambda id.
description: response with lambda id.
required: [lambda_id]
lambda_version:
type: integer
description: |
lambda version
The lambda version incremented after each lambda recreation ([put request](#tag/lambdas-creation/operation/putLambda))
minimum: 0
example: 5
lambda_version_response:
type: object
properties:
version:
$ref: '#/components/schemas/lambda_version'
description: response with lambda version.
required: [ version ]
lambda_name:
type: string
description: Lambda name. Each user can create only lambdas with unique names.
example: first-lambda
lambda_type:
type: string
enum: [standalone, handlers]
description: Lambda type.
example: standalone
default: "standalone"
lambda_status:
type: string
enum: [running, waiting, terminated, not_found]
description: |
lambda status
| status | description |
|------------|---------------------------------------------------------|
| running | lambda running and ready to process requests |
| waiting | waiting for lambda start or lambda creation in progress |
| terminated | lambda stopped and will be removed in the near future |
| not_found | lambda not found |
example: running
lambda_status_response:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/lambda_status'
description: response with lambda status.
required: [status]
description:
type: string
description: lambda description
example: very useful lambda
maxLength: 256
default: ""
lambda_patch:
type: object
description: lambda patch data
properties:
lambda_name:
$ref: '#/components/schemas/lambda_name'
description:
type: string
description: lambda description
example: very useful lambda
maxLength: 256
minProperties: 1
user_docker_commands:
type: array
default: []
items:
type: string
description: |
list of additional user docker commands for lambda container building (see development manual for details)
For example to use python library with libjpeg dependency in lambda add the following list of command to `user_docker_commands`
```json
["RUN yum install -y epel-release", "RUN yum install -y libjpeg-turbo-devel"]
```
lambda_multipart_content-archive_file:
type: object
properties:
archive:
type: string
format: binary
description: |
Archive file with zip extension.
Content-Type must be "application/zip".
credentials:
type: object
description: |
Lambda credentials.
Content-Type must be "application/json".
properties:
lambda_name:
type: string
minLength: 3
maxLength: 36
description: Lambda name
description:
$ref: '#/components/schemas/description'
required: [lambda_name]
parameters:
type: object
description: Parameters for lambda.
properties:
lambda_type:
$ref: '#/components/schemas/lambda_type'
additional_user_docker_commands:
$ref: '#/components/schemas/user_docker_commands'
description: lambda multipart content with archive file.
required: [ archive, credentials ]
lambda:
type: object
properties:
account_id:
$ref: '#/components/schemas/account_id'
lambda_id:
allOf:
- $ref: '#/components/schemas/uuid'
- description: lambda id.
lambda_name:
allOf:
- $ref: '#/components/schemas/lambda_name'
description:
$ref: '#/components/schemas/description'
version:
$ref: '#/components/schemas/lambda_version'
info:
type: object
description: lambda info
properties:
status:
$ref: '#/components/schemas/lambda_status'
required: [status]
lambda_type:
$ref: '#/components/schemas/lambda_type'
create_time:
allOf:
- $ref: "#/components/schemas/time"
- format: date-time
description: time of the lambda creation.
last_update_time:
allOf:
- $ref: '#/components/schemas/time'
description: date and time with timezone of last action with lambda.
additional_user_docker_commands:
$ref: '#/components/schemas/user_docker_commands'
required: [lambda_id, lambda_name, version, info, create_time, last_update_time, account_id, description, lambda_type, additional_user_docker_commands]
image_creation_status:
type: object
properties:
status:
type: string
enum: [not_found, in_progress, error, completed]
description: |
lambda image creation status
| status | description |
|-------------|---------------------------------------------------------------------------|
| in_progress | image creation in progress, lambda creation will start in the near future |
| error | an error occured during image creation |
| completed | image creation completed but not cleaned up yet |
| not_found | image creation complete and cleaned up or it never was |
required: [status]
lambda_logs:
type: object
properties:
logs:
type: array
items:
type: string
description: lambda log strings.
description: lambda logs.
required: [logs]
lambda_validation_error_response:
type: object
properties:
errors:
type: array
items:
type: string
description: lambda validate errors.
example: [ validation_error_one, validation_error_two ]
description: response of lambda validation.
required: [ errors ]
responses:
internal_server_error:
description: internal server error.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
method_not_allowed:
description: method not allowed.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 12021
desc: Method not allowed
detail: Method not allowed
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12021"
lambda_already_exists_by_name:
description: lambda with specified name already exists.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42003
desc: Unique constraint error
detail: 'Lambda with name good_lambda already exists'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42003"
lambda_not_found:
description: lambda not found.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id 'e63e2a1f-f505-441c-8e11-b2dcd0385329' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12013"
lambda_or_page_not_found:
description: lambda not found or page not found.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
lambda_not_found:
value:
error_code: 42001
desc: Object not found
detail: Lambda with id 'e63e2a1f-f505-441c-8e11-b2dcd0385329' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12013"
lambda_page_not_found:
value:
error_code: 12013
desc: Resource not found
detail: Page not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12013"
license_problem:
description: license problem.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 11055
desc: Forbidden
detail: "License problem: 'License expired'"
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11055"
paths:
/version:
get:
tags:
- version
summary: get version
description: get service version
operationId: getVersion
parameters:
- $ref: '#/components/parameters/luna_request_id'
responses:
200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/version'
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas:
post:
tags:
- lambdas creation
summary: create lambda
description: |
Start new lambda creation process.
Lambda creation comprises in two parts:
- docker image creation | process can be seen by [image monitoring](#tag/lambda-image-monitoring)
- lambda creation and launching | process can be seen by [lambda monitoring](#tag/lambda-monitoring)
After lambda creation process will be completed lambda status will be changed to `running` and it will be
ready to process requests. For more details see development manual.
operationId: createLambda
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/application_multipart_content'
- $ref: '#/components/parameters/header_account_id'
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/lambda_multipart_content-archive_file'
required: true
responses:
202:
description: Lambda creation executed successfully.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Location:
schema:
type: string
format: url
example: /1/lambdas/b5d6fd45-fcca-453d-ac05-3e594054b813
description: location of the lambda.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/lambda_id_response'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
archive_not_contains_file:
value:
error_code: 12048
desc: Bad/incomplete input data
detail: 'Archive file does not contain lambda.py'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12048"
unknown_multipart_name:
value:
error_code: 12039
desc: Bad/incomplete input data
detail: 'Unknown multipart name ''account'''
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12039"
duplicate_multipart_name:
value:
error_code: 12040
desc: Bad/incomplete input data
detail: 'Duplicate multipart name ''lambda_name'''
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12040"
bad_multipart_content_type:
value:
error_code: 12041
desc: Bad/incomplete input data
detail: 'Multipart with name ''lambda_name'' has bad Content-Type'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12041"
account_id_not_found:
value:
error_code: 11066
desc: Bad/incomplete input data
detail: Luna-Account-Id header not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11066"
bad_account_id:
value:
error_code: 11037
desc: Bad/incomplete input data
detail: "Luna-Account-Id header is not UUID, format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11037"
403:
$ref: '#/components/responses/license_problem'
409:
$ref: '#/components/responses/lambda_already_exists_by_name'
500:
$ref: '#/components/responses/internal_server_error'
get:
tags:
- lambda monitoring
summary: get lambdas
description: Get lambdas according to filters.
operationId: getLambdas
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/create_time__lt'
- $ref: '#/components/parameters/create_time__gte'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/page_size'
- $ref: '#/components/parameters/lambda_type'
- $ref: '#/components/parameters/lambda_name'
responses:
200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
type: object
properties:
lambdas:
description: lambdas
type: array
items:
$ref: '#/components/schemas/lambda'
minItems: 0
required: [lambdas]
400:
description: Bad request.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
bad_query_param:
value:
error_code: 12012
desc: Bad/incomplete input data
detail: Bad query parameters 'create_time__lt'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas/validator:
post:
tags:
- lambdas validator
summary: validation lambda
description: |
Lambda validation.
Lambda validation not guarantees hassle-free lambda creation and execution, but is an integral part of lambda
creation process and allows you to make sure that the archive and its contents meet the requirements.
operationId: validationLambda
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/application_multipart_content'
requestBody:
content:
application/zip:
schema:
type: object
properties:
archive:
type: string
format: binary
description: |
Archive file with zip extension.
Content-Type must be "application/zip".
parameters:
type: object
description: Parameters for lambda.
properties:
lambda_type:
$ref: '#/components/schemas/lambda_type'
required: [lambda_type]
required: [ archive, parameters ]
required: true
responses:
204:
description: Lambda validation success.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
400:
description: Validate lambda error.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/lambda_validation_error_response'
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas/{lambda_id}:
parameters:
- in: path
name: lambda_id
schema:
$ref: '#/components/schemas/uuid'
required: true
description: ID of the lambda.
put:
tags:
- lambdas creation
summary: put lambda
description: |
Execute lambda recreation.
The lambda version will be incremented after recreation finish.
Lambda recreation comprises in three parts:
- old lambda removing
- docker image creation | process can be seen by [image monitoring](#tag/lambda-image-monitoring)
- lambda creation and launching | process can be seen by [lambda monitoring](#tag/lambda-monitoring)
After lambda creation process will be completed lambda status will be changed to `running` and it will be
ready to process requests. For more details see development manual.
operationId: putLambda
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/application_multipart_content'
- $ref: '#/components/parameters/header_account_id'
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/lambda_multipart_content-archive_file'
required: true
responses:
200:
description: Lambda recreation executed successfully.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Location:
schema:
type: string
format: url
example: /1/lambdas/b5d6fd45-fcca-453d-ac05-3e594054b813
description: location of the lambda.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/lambda_version_response'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
archive_not_contains_file:
value:
error_code: 12048
desc: Bad/incomplete input data
detail: 'Archive file does not contain lambda.py'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12048"
unknown_multipart_name:
value:
error_code: 12039
desc: Bad/incomplete input data
detail: 'Unknown multipart name ''account'''
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12039"
duplicate_multipart_name:
value:
error_code: 12040
desc: Bad/incomplete input data
detail: 'Duplicate multipart name ''lambda_name'''
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12040"
bad_multipart_content_type:
value:
error_code: 12041
desc: Bad/incomplete input data
detail: 'Multipart with name ''lambda_name'' has bad Content-Type'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12041"
account_id_not_found:
value:
error_code: 11066
desc: Bad/incomplete input data
detail: Luna-Account-Id header not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11066"
bad_account_id:
value:
error_code: 11037
desc: Bad/incomplete input data
detail: "Luna-Account-Id header is not UUID, format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11037"
403:
$ref: '#/components/responses/license_problem'
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
409:
$ref: '#/components/responses/lambda_already_exists_by_name'
500:
$ref: '#/components/responses/internal_server_error'
patch:
tags:
- lambdas creation
summary: patch lambda
description: patch lambda.
operationId: patchLambda
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/application_json_content'
- $ref: '#/components/parameters/header_account_id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/lambda_patch'
required: true
responses:
204:
description: Lambda patched successfully.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
account_id_not_found:
value:
error_code: 11066
desc: Bad/incomplete input data
detail: Luna-Account-Id header not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11066"
bad_account_id:
value:
error_code: 11037
desc: Bad/incomplete input data
detail: "Luna-Account-Id header is not UUID, format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11037"
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
500:
$ref: '#/components/responses/internal_server_error'
get:
tags:
- lambda monitoring
summary: get lambda
description: Get lambda by ID.
operationId: getLambda
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
200:
description: OK
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/lambda'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
bad_content_type:
value:
error_code: 12017
desc: Bad/incomplete input data
detail: Bad content type
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
bad_query_param:
value:
error_code: 12012
desc: Bad/incomplete input data
detail: Bad query parameters 'account_id'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
500:
$ref: '#/components/responses/internal_server_error'
head:
tags:
- lambda monitoring
summary: check lambda existence
description: Check existence of the lambda by ID.
operationId: checkLambda
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
200:
description: lambda exists
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
bad_query_param:
value:
error_code: 12012
desc: Bad/incomplete input data
detail: Bad query parameters 'account_id'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
500:
$ref: '#/components/responses/internal_server_error'
delete:
tags:
- lambdas deletion
summary: delete lambda
description: Remove lambda by ID.
operationId: deleteLambda
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
204:
description: Delete success.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
bad_query_param:
value:
error_code: 12012
desc: Bad/incomplete input data
detail: Bad query parameters 'account_id'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas/{lambda_id}/update:
parameters:
- in: path
name: lambda_id
schema:
$ref: '#/components/schemas/uuid'
required: true
description: ID of the lambda.
post:
tags:
- lambda update
summary: update lambda
description: |
update lambda using latest base image.
The luna-platform update may cause incompatibility with old lambdas. To make the old lambdas compatible with
actual luna-platform it needs to update lambda. For more details see development manual.
operationId: updateLambda
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/header_account_id'
responses:
200:
description: Lambda update executed successfully.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Location:
schema:
type: string
format: url
example: /1/lambdas/b5d6fd45-fcca-453d-ac05-3e594054b813
description: location of the lambda.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/lambda_version_response'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
account_id_not_found:
value:
error_code: 11066
desc: Bad/incomplete input data
detail: Luna-Account-Id header not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11066"
bad_account_id:
value:
error_code: 11037
desc: Bad/incomplete input data
detail: "Luna-Account-Id header is not UUID, format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11037"
403:
$ref: '#/components/responses/license_problem'
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
lambda_not_found:
value:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
archive_not_found:
value:
error_code: 42005
desc: Lambda archive not found
detail: Archive of lambda '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found in S3. Read developer guide for more information
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42005"
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas/{lambda_id}/image/status:
parameters:
- in: path
name: lambda_id
schema:
$ref: '#/components/schemas/uuid'
required: true
description: ID of the lambda.
get:
tags:
- lambda image monitoring
summary: get lambda image creation status
description: |
Get lambda image creation status by lambda ID.
If lambda image creation is in progress, lambda status will be `waiting`.
After lambda image creation will end, the lambda image creation job will be removed and status will be `not_found`.
For more information about lambda and lambda images statuses see development manual.
operationId: getLambdaImageStatus
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
200:
description: OK
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/image_creation_status'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
bad_content_type:
value:
error_code: 12017
desc: Bad/incomplete input data
detail: Bad content type
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
bad_query_param:
value:
error_code: 12012
desc: Bad/incomplete input data
detail: Bad query parameters 'account_id'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas/{lambda_id}/image/logs:
parameters:
- in: path
name: lambda_id
schema:
$ref: '#/components/schemas/uuid'
required: true
description: ID of the lambda.
get:
tags:
- lambda image monitoring
summary: get lambda image creation logs
description: |
Get lambda image creation logs by lambda ID.
During the creation of the lambda image, it is possible to get logs to monitor the progress.
For more information about lambda and lambda images logs see development manual.
operationId: getLambdaImageCreationLogs
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/tail_lines'
responses:
200:
description: OK
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/lambda_logs'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
bad_content_type:
value:
error_code: 12017
desc: Bad/incomplete input data
detail: Bad content type
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
bad_query_param:
value:
error_code: 12012
desc: Bad/incomplete input data
detail: Bad query parameters 'account_id'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas/{lambda_id}/status:
parameters:
- in: path
name: lambda_id
schema:
$ref: '#/components/schemas/uuid'
required: true
description: ID of the lambda.
get:
tags:
- lambda monitoring
summary: get lambda status
description: |
Get lambda status by ID.
If lambda image creation is in progress, lambda status will be `waiting`.
For more information about lambda and lambda images statuses see development manual.
operationId: getLambdaStatus
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
200:
description: OK
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/lambda_status_response'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
bad_content_type:
value:
error_code: 12017
desc: Bad/incomplete input data
detail: Bad content type
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
bad_query_param:
value:
error_code: 12012
desc: Bad/incomplete input data
detail: Bad query parameters 'account_id'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas/{lambda_id}/logs:
parameters:
- in: path
name: lambda_id
schema:
$ref: '#/components/schemas/uuid'
required: true
description: ID of the lambda.
get:
tags:
- lambda monitoring
summary: get lambda logs
description: |
Get lambda logs by ID.
After lambda creation has been executed, there is possibility to get lambda logs.
For more information about lambda and lambda images logs see development manual.
operationId: getLambdaLogs
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/tail_lines'
responses:
200:
description: OK
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/lambda_logs'
400:
description: Bad request.
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
bad_content_type:
value:
error_code: 12017
desc: Bad/incomplete input data
detail: Bad content type
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
bad_query_param:
value:
error_code: 12012
desc: Bad/incomplete input data
detail: Bad query parameters 'account_id'
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
404:
description: Lambda not found.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
Content-Type:
$ref: '#/components/headers/application_json'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error_code: 42001
desc: Object not found
detail: Lambda with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-42001"
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas/{lambda_id}/docs/spec:
parameters:
- in: path
name: lambda_id
schema:
$ref: '#/components/schemas/uuid'
required: true
description: ID of the lambda.
get:
tags:
- lambda documentation
summary: get lambda openapi documentation
description: |
Get lambda OpenApi documentation. If *Accept* request header is of type `application/x-yaml`,
returns documentation in `yaml` format or returns `html` documentation, if *Accept-Type* is `text/html`
operationId: getLambdaSpec
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/accept_docs_handler'
responses:
200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/docs_content_type'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/x-yaml:
schema:
type: string
description: yaml format documentation
text/html:
schema:
type: string
description: html format documentation
404:
$ref: '#/components/responses/lambda_not_found'
415:
description: Unsupported Media Type
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
unsupported_media_type:
value:
error_code: 12024
detail: 'Bad/incomplete input data'
desc: "Unsupported media type"
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12024"
500:
$ref: '#/components/responses/internal_server_error'
/1/lambdas/{lambda_id}/proxy:
parameters:
- in: path
name: lambda_id
schema:
$ref: '#/components/schemas/uuid'
required: true
description: ID of the lambda.
- in: path
name: path_parameters
schema:
type: string
description: additional path parameters
example: /main
required: false
description: any additional path parameter will be use as path parameter to lambda
post:
tags:
- lambda proxy
summary: proxy post request to lambda
description: |
Proxy POST request to lambda.
Request and response headers, query parameters and body description
[must be provided](#operation/getLambdaSpec) by lambda documentation.
Described headers will be processed and received independently of lambda behavior.
operationId: proxyLambdaPost
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/header_account_id'
responses:
200:
description: Success.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
403:
$ref: '#/components/responses/license_problem'
404:
$ref: '#/components/responses/lambda_or_page_not_found'
415:
$ref: '#/components/responses/method_not_allowed'
500:
$ref: '#/components/responses/internal_server_error'
get:
tags:
- lambda proxy
summary: proxy get request to lambda
description: |
Proxy GET request to lambda.
Request and response headers, query parameters and body description
[must be provided](#operation/getLambdaSpec) by lambda documentation.
Described headers will be processed and received independently of lambda behavior.
operationId: proxyLambdaGet
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
200:
description: Success.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
403:
$ref: '#/components/responses/license_problem'
404:
$ref: '#/components/responses/lambda_or_page_not_found'
415:
$ref: '#/components/responses/method_not_allowed'
500:
$ref: '#/components/responses/internal_server_error'
head:
tags:
- lambda proxy
summary: proxy head request to lambda
description: |
Proxy HEAD request to lambda.
Request and response headers, query parameters and body description
[must be provided](#operation/getLambdaSpec) by lambda documentation.
Described headers will be processed and received independently of lambda behavior.
operationId: proxyLambdaHead
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
200:
description: Success.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
403:
$ref: '#/components/responses/license_problem'
404:
$ref: '#/components/responses/lambda_or_page_not_found'
415:
$ref: '#/components/responses/method_not_allowed'
500:
$ref: '#/components/responses/internal_server_error'
put:
tags:
- lambda proxy
summary: proxy put request to lambda
description: |
Proxy PUT request to lambda.
Request and response headers, query parameters and body description
[must be provided](#operation/getLambdaSpec) by lambda documentation.
Described headers will be processed and received independently of lambda behavior.
operationId: proxyLambdaPut
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/header_account_id'
responses:
200:
description: Success.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
403:
$ref: '#/components/responses/license_problem'
404:
$ref: '#/components/responses/lambda_or_page_not_found'
415:
$ref: '#/components/responses/method_not_allowed'
500:
$ref: '#/components/responses/internal_server_error'
patch:
tags:
- lambda proxy
summary: proxy patch request to lambda
description: |
Proxy PATCH request to lambda.
Request and response headers, query parameters and body description
[must be provided](#operation/getLambdaSpec) by lambda documentation.
Described headers will be processed and received independently of lambda behavior.
operationId: proxyLambdaPatch
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
200:
description: Success.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
403:
$ref: '#/components/responses/license_problem'
404:
$ref: '#/components/responses/lambda_or_page_not_found'
415:
$ref: '#/components/responses/method_not_allowed'
500:
$ref: '#/components/responses/internal_server_error'
delete:
tags:
- lambda proxy
summary: proxy delete request to lambda
description: |
Proxy DELETE request to lambda.
Request and response headers, query parameters and body description
[must be provided](#operation/getLambdaSpec) by lambda documentation.
Described headers will be processed and received independently of lambda behavior.
operationId: proxyLambdaDelete
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
200:
description: Success.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
403:
$ref: '#/components/responses/license_problem'
404:
$ref: '#/components/responses/lambda_or_page_not_found'
415:
$ref: '#/components/responses/method_not_allowed'
500:
$ref: '#/components/responses/internal_server_error'
options:
tags:
- lambda proxy
summary: proxy options request to lambda
description: |
Proxy OPTIONS request to lambda.
Request and response headers, query parameters and body description
[must be provided](#operation/getLambdaSpec) by lambda documentation.
Described headers will be processed and received independently of lambda behavior.
operationId: proxyLambdaOptions
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/account_id'
responses:
200:
description: Success.
headers:
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
404:
$ref: '#/components/responses/lambda_or_page_not_found'
415:
$ref: '#/components/responses/method_not_allowed'
500:
$ref: '#/components/responses/internal_server_error'
/1/docs/spec:
get:
tags:
- documents
summary: get openapi documentation
description: |
Get service OpenApi documentation. If *Accept* request header is of type `application/x-yaml`,
returns documentation in `yaml` format or returns `html` documentation, if *Accept-Type* is `text/html`
operationId: getSpec
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/accept_docs_handler'
responses:
200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/docs_content_type'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/x-yaml:
schema:
type: string
description: yaml format documentation
text/html:
schema:
type: string
description: html format documentation
415:
description: Unsupported Media Type
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
unsupported_media_type:
value:
error_code: 12024
detail: 'Bad/incomplete input data'
desc: "Unsupported media type"
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12024"
500:
$ref: '#/components/responses/internal_server_error'
/1/docs/dev:
parameters:
- $ref: '#/components/parameters/Accept'
get:
tags:
- documents
summary: get development manual
description: |
Get sphinx documentation - *Development Manual*. After the request you will be redirected to the page `/docs/dev/index.html`
operationId: getDevManual
parameters:
- $ref: '#/components/parameters/luna_request_id'
responses:
200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/text_html'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
text/html:
schema:
type: string
description: html format documentation
500:
$ref: '#/components/responses/internal_server_error'
/1/config:
get:
tags:
- config
summary: get service configuration
description: Get service configuration. Passwords and tokens will be hidden in the response.
operationId: getConfig
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/accept_config_handler'
responses:
200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/config_accept_content_type'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
type: object
description: json format configuration
example:
INFLUX_MONITORING:
SEND_DATA_FOR_MONITORING: 0
VERSION: 2
ORGANIZATION: ORGANIZATION_NAME
TOKEN: '********'
BUCKET: luna_monitoring
HOST: 127.0.0.1
PORT: 8086
USE_SSL: 0
FLUSHING_PERIOD: 1.0
text/plain:
schema:
type: string
description: text format configuration
example: |
[INFLUX_MONITORING]
SEND_DATA_FOR_MONITORING = 0
VERSION = 2
ORGANIZATION = ORGANIZATION_NAME
TOKEN = ********
BUCKET = luna_monitoring
HOST = 127.0.0.1
PORT = 8086
USE_SSL = 0
FLUSHING_PERIOD = 1.0
415:
description: Unsupported Media Type
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
unsupported_media_type:
value:
error_code: 12024
detail: 'Bad/incomplete input data'
desc: "Unsupported media type"
link: "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12024"
500:
$ref: '#/components/responses/internal_server_error'
/healthcheck:
get:
tags:
- health
summary: get health
description: get health of service
operationId: healthcheck
parameters:
- $ref: '#/components/parameters/luna_request_id'
- $ref: '#/components/parameters/include_luna_services'
responses:
200:
description: OK
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/health_ok'
500:
$ref: '#/components/responses/internal_server_error'
502:
description: Unhealthy
headers:
Content-Type:
$ref: '#/components/headers/application_json'
Luna-Request-Id:
$ref: '#/components/headers/luna_request_id'
content:
application/json:
schema:
$ref: '#/components/schemas/health_errors'