From fa0b4c1d99c7f2731cbaeac86861235af72eeda9 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 14 Nov 2023 16:36:11 +0000 Subject: [PATCH] Publish docs --- index.html | 6 +++--- openapi.yaml | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/index.html b/index.html index 343eecd0..8bec5b48 100644 --- a/index.html +++ b/index.html @@ -5451,8 +5451,8 @@

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Variable Main Calls

List variables

Returns a list of variables. The result can be filtered by using the query parameters.

-
Authorizations:
bearerAuthApiKeyAuth
query Parameters
parent_id
string <uuid>

it filters the list by returning only the variables accessible by the selected parent_id. This field shall contain the id of a project, environment or service depending on the selected scope. Example, if scope = APPLICATION and parent_id=, the result will contain any variable accessible by the application. The result will contain also any variable declared at an higher scope.

-
scope
string (APIVariableScopeEnum)
Enum: "APPLICATION" "BUILT_IN" "ENVIRONMENT" "PROJECT" "CONTAINER" "JOB"

the type of the parent_id (application, project, environment etc..).

+
Authorizations:
bearerAuthApiKeyAuth
query Parameters
parent_id
required
string <uuid>

it filters the list by returning only the variables accessible by the selected parent_id. This field shall contain the id of a project, environment or service depending on the selected scope. Example, if scope = APPLICATION and parent_id=, the result will contain any variable accessible by the application. The result will contain also any variable declared at an higher scope.

+
scope
required
string (APIVariableScopeEnum)
Enum: "APPLICATION" "BUILT_IN" "ENVIRONMENT" "PROJECT" "CONTAINER" "JOB"

the type of the parent_id (application, project, environment etc..).

is_secret
boolean or null

it filters the list by returning only the variables of type secret or not

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "user_email": "string",
  • "type_of_use": "PERSONAL",
  • "qovery_usage": "string",
  • "company_name": "string",
  • "company_size": "1-10",
  • "user_role": "string",
  • "qovery_usage_other": "string",
  • "user_questions": "string",
  • "current_step": "string",
  • "dx_auth": true
}