Schemas

# APIKey

{
  "key": "stringstringstringstringstringstringstri"
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
key	string	true	40	40	none	^key_

# HTTPValidationError

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
detail	[ValidationError]	false	none	none	none	none

# MessageModel

{
  "message": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
message	string	false	none	none	none	none

# OblvAuthResponse

{
  "token": "",
  "user_id": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
token	string	false	none	none	none	none
user_id	string	false	none	none	none	none

# ValidationError

{
  "loc": [
    "string"
  ],
  "msg": "string",
  "type": "string"
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
loc	[string]	true	none	none	none	none
msg	string	true	none	none	none	none
type	string	true	none	none	none	none

# Account

{
  "user_id": "",
  "user_login": "",
  "account_type": "github"
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
user_id	string	false	none	none	none	none
user_login	string	false	none	none	none	none
account_type	string	false	none	none	none	none

# NameInput

{
  "name": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
name	string	false	none	none	none	none

# PSK

{
  "public_key": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring"
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
public_key	string	true	360	360	none	^MIIB(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==

# Repo

{
  "repo_id": "",
  "name": "",
  "full_name": "",
  "is_private": false,
  "owner_login": "",
  "description": "",
  "html_url": "",
  "git_url": "",
  "clone_url": "",
  "default_branch": "",
  "updated_at": "",
  "account_type": "github"
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
repo_id	string	false	none	none	none	none
name	string	false	none	none	none	none
full_name	string	false	none	none	none	none
is_private	boolean	false	none	none	none	none
owner_login	string	false	none	none	none	none
description	string	false	none	none	none	none
html_url	string	false	none	none	none	none
git_url	string	false	none	none	none	none
clone_url	string	false	none	none	none	none
default_branch	string	false	none	none	none	none
updated_at	string	false	none	none	none	none
account_type	string	false	none	none	none	none

# RepoAllResponse

{
  "name": "",
  "owner_login": "",
  "account_type": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
name	string	false	none	none	none	none
owner_login	string	false	none	none	none	none
account_type	string	false	none	none	none	none

# UserCreditUtilization

{
  "total_credits": 0,
  "total_running_deployments": 0,
  "esitmated_hours_remaining": 0,
  "hourly_credit_utilization": 0
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
total_credits	integer	false	none	none	none	none
total_running_deployments	integer	false	none	none	none	none
esitmated_hours_remaining	integer	false	none	none	none	none
hourly_credit_utilization	integer	false	none	none	none	none

# UserPasswordInput

{
  "old_password": "string",
  "password": "string"
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
old_password	string	true	50	none	none	none
password	string	true	none	none	none	^(?=.?[A-Z])(?=.?[a-z])(?=.?[0-9])(?=.?[#?!@$%^&*-]).{8,128}$

# UserProfileResponse

{
  "oblivious_login": "",
  "email": "",
  "user_name": "",
  "public_key": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
oblivious_login	string	false	none	none	none	none
email	string	false	none	none	none	none
user_name	string	false	none	none	none	none
public_key	string	false	none	none	none	none

# UserServiceList

{
  "total_pages": "",
  "services": []
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
total_pages	integer	false	none	none	none	none
services	[UserServices]	false	none	none	none	none

# UserServices

{
  "repo_name": "",
  "repo_owner": "",
  "account_type": "",
  "ref": "",
  "service_validated": false,
  "sha": "",
  "type": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
repo_name	string	false	none	none	none	none
repo_owner	string	false	none	none	none	none
account_type	string	false	none	none	none	none
ref	string	false	none	none	none	none
service_validated	boolean	false	none	none	none	none
sha	string	false	none	none	none	none
type	string	false	none	none	none	none

# RefResponse

{
  "tags": [],
  "branch": []
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
tags	[string]	false	none	none	none	none
branch	[string]	false	none	none	none	none

# RepoServiceList

{
  "total_pages": "",
  "services": []
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
total_pages	integer	false	none	none	none	none
services	[ValidatedService]	false	none	none	none	none

# ServiceValidationResponse

{
  "message": "",
  "service": {
    "ref": "",
    "service_validated": true,
    "sha": "",
    "type": ""
  }
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
message	string	false	none	none	none	none
service	ValidatedService	false	none	none	none	none

# VCSRepoResponse

{
  "repos": [],
  "total_pages": 0,
  "message": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
repos	[Repo]	false	none	none	none	none
total_pages	integer	false	none	none	none	none
message	string	false	none	none	none	none

# ValidatedService

{
  "ref": "",
  "service_validated": true,
  "sha": "",
  "type": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
ref	string	false	none	none	none	none
service_validated	boolean	false	none	none	none	none
sha	string	false	none	none	none	none
type	string	false	none	none	none	none

# AccessHistory

{
  "action": "",
  "timestamp": "05-01-2023 06:33:17",
  "oblivious_user_id": "",
  "role": "string"
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
action	string	false	none	none	none	none
timestamp	string	false	none	none	none	none
oblivious_user_id	string	false	none	none	none	none
role	string	false	none	none	none	none

# AvailableDeployment

{
  "role": [
    "string"
  ],
  "deployment": {
    "deployment_id": "",
    "deployment_name": "",
    "owner": "",
    "repo_name": "",
    "account_type": "",
    "repo_owner": "",
    "tags": [],
    "branch_release": "",
    "current_state": "",
    "visibility": "",
    "is_dev_env": true,
    "creation_time": "",
    "sha": "",
    "owner_login": "",
    "is_deleted": false,
    "instance": {
      "region_name": "",
      "stack_name": "",
      "instance_type": "",
      "instance_url": "",
      "service_url": "",
      "build_log_location": ""
    },
    "pcr_codes": [],
    "credit_utilization_per_hour": 0,
    "total_credits_used": 0,
    "build_args": null,
    "shared_users": [],
    "history": []
  }
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
role	[string]	true	none	none	none	none
deployment	DeploymentComplete	true	none	none	none	none

# AvailableDeploymentList

{
  "total_pages": 0,
  "deployments": [
    {
      "role": [
        "string"
      ],
      "deployment": {
        "deployment_id": "",
        "deployment_name": "",
        "owner": "",
        "repo_name": "",
        "account_type": "",
        "repo_owner": "",
        "tags": [],
        "branch_release": "",
        "current_state": "",
        "visibility": "",
        "is_dev_env": true,
        "creation_time": "",
        "sha": "",
        "owner_login": "",
        "is_deleted": false,
        "instance": {
          "region_name": "",
          "stack_name": "",
          "instance_type": "",
          "instance_url": "",
          "service_url": "",
          "build_log_location": ""
        },
        "pcr_codes": [],
        "credit_utilization_per_hour": 0,
        "total_credits_used": 0,
        "build_args": null,
        "shared_users": [],
        "history": []
      }
    }
  ]
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
total_pages	integer	true	none	none	none	none
deployments	[AvailableDeployment]	true	none	none	none	none

# BuildArgsSchema

{
  "sha": "",
  "arg_schema": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
sha	string	false	none	none	none	none
arg_schema	any	false	none	none	none	none

# CreateDeploymentInput

{
  "owner": "string",
  "repo": "string",
  "account_type": "string",
  "ref": "string",
  "ref_type": "string",
  "region_name": "string",
  "deployment_name": "string",
  "visibility": "private",
  "is_dev_env": true,
  "tags": [
    "string"
  ],
  "build_args": null
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
owner	string	true	none	none	Repository Owner	^[a-zA-Z\d](?:[a-zA-Z\d]
repo	string	true	none	none	Repository Name	^(([a-zA-Z\d_-][a-zA-Z\d._-]{0,99})
account_type	string	true	none	none	VCS Account (Only 'github' supported as of now)	^github$
ref	string	true	200	1	Service ref	none
ref_type	string	true	none	none	Service ref type	^(branch|tag)$
region_name	string	true	none	none	AWS supported region the deployment must be deployed in.	^(us-east-1
deployment_name	string	true	50	3	Deployment Name	none
visibility	string	false	none	none	Deployment Visibility	^(private
is_dev_env	boolean	true	none	none	Deployment Environment	none
tags	[string]	true	none	none	Deployment Tags	none
build_args	any	true	none	none	Deployment build args	none

# CreateDeploymentResponse

{
  "deployment_id": "",
  "message": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
deployment_id	string	false	none	none	none	none
message	string	false	none	none	none	none

# DeploymentComplete

{
  "deployment_id": "",
  "deployment_name": "",
  "owner": "",
  "repo_name": "",
  "account_type": "",
  "repo_owner": "",
  "tags": [],
  "branch_release": "",
  "current_state": "",
  "visibility": "",
  "is_dev_env": true,
  "creation_time": "",
  "sha": "",
  "owner_login": "",
  "is_deleted": false,
  "instance": {
    "region_name": "",
    "stack_name": "",
    "instance_type": "",
    "instance_url": "",
    "service_url": "",
    "build_log_location": ""
  },
  "pcr_codes": [],
  "credit_utilization_per_hour": 0,
  "total_credits_used": 0,
  "build_args": null,
  "shared_users": [],
  "history": []
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
deployment_id	string	false	none	none	none	none
deployment_name	string	false	none	none	none	none
owner	string	false	none	none	none	none
repo_name	string	false	none	none	none	none
account_type	string	false	none	none	none	none
repo_owner	string	false	none	none	none	none
tags	[string]	false	none	none	none	none
branch_release	string	false	none	none	none	none
current_state	string	false	none	none	none	none
visibility	string	false	none	none	none	none
is_dev_env	boolean	false	none	none	none	none
creation_time	string	false	none	none	none	none
sha	string	false	none	none	none	none
owner_login	string	false	none	none	none	none
is_deleted	boolean	false	none	none	none	none
instance	Instance	false	none	none	none	none
pcr_codes	[string]	false	none	none	none	none
credit_utilization_per_hour	number	false	none	none	none	none
total_credits_used	number	false	none	none	none	none
build_args	any	false	none	none	none	none
shared_users	[SharedUsers]	false	none	none	none	none
history	[AccessHistory]	false	none	none	none	none

# DeploymentList

{
  "total_pages": 0,
  "deployments": [
    {
      "deployment_id": "",
      "deployment_name": "",
      "owner": "",
      "repo_name": "",
      "account_type": "",
      "repo_owner": "",
      "tags": [],
      "branch_release": "",
      "current_state": "",
      "visibility": "",
      "is_dev_env": true,
      "creation_time": "",
      "sha": "",
      "owner_login": "",
      "is_deleted": false,
      "instance": {
        "region_name": "",
        "stack_name": "",
        "instance_type": "",
        "instance_url": "",
        "service_url": "",
        "build_log_location": ""
      },
      "pcr_codes": [],
      "credit_utilization_per_hour": 0,
      "total_credits_used": 0,
      "build_args": null,
      "shared_users": [],
      "history": []
    }
  ]
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
total_pages	integer	true	none	none	none	none
deployments	[DeploymentComplete]	true	none	none	none	none

# DeploymentResponse

{
  "deployment_id": "",
  "deployment_name": "",
  "owner_login": "",
  "repo_name": "",
  "account_type": "",
  "repo_owner": "",
  "tags": [],
  "branch_release": "",
  "current_state": "",
  "visibility": "",
  "is_dev_env": true,
  "pcr_codes": [],
  "credit_utilization_per_hour": 0,
  "creation_time": "",
  "sha": "",
  "is_deleted": false,
  "build_args": {},
  "instance": {
    "region_name": "",
    "stack_name": "",
    "instance_type": "",
    "instance_url": "",
    "service_url": "",
    "build_log_location": ""
  },
  "shared_users": []
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
deployment_id	string	false	none	none	none	none
deployment_name	string	false	none	none	none	none
owner_login	string	false	none	none	none	none
repo_name	string	false	none	none	none	none
account_type	string	false	none	none	none	none
repo_owner	string	false	none	none	none	none
tags	[string]	false	none	none	none	none
branch_release	string	false	none	none	none	none
current_state	string	false	none	none	none	none
visibility	string	false	none	none	none	none
is_dev_env	boolean	false	none	none	none	none
pcr_codes	[string]	false	none	none	none	none
credit_utilization_per_hour	number	false	none	none	none	none
creation_time	string	false	none	none	none	none
sha	string	false	none	none	none	none
is_deleted	boolean	false	none	none	none	none
build_args	any	false	none	none	none	none
instance	Instance	false	none	none	none	none
shared_users	[SharedUsers]	false	none	none	none	none

# Instance

{
  "region_name": "",
  "stack_name": "",
  "instance_type": "",
  "instance_url": "",
  "service_url": "",
  "build_log_location": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
region_name	string	false	none	none	none	none
stack_name	string	false	none	none	none	none
instance_type	string	false	none	none	none	none
instance_url	string	false	none	none	none	none
service_url	string	false	none	none	none	none
build_log_location	string	false	none	none	none	none

# RoleResponse

{
  "role_name": "",
  "role_description": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
role_name	string	false	none	none	none	none
role_description	string	false	none	none	none	none

# SharedUsers

{
  "oblivious_user_id": "",
  "use_case": "",
  "role": [
    "string"
  ],
  "oblivious_login": ""
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
oblivious_user_id	string	false	none	none	none	none
use_case	string	false	none	none	none	none
role	[string]	true	none	none	none	none
oblivious_login	string	false	none	none	none	none

# NotificationResponse

{
  "id": "",
  "summary": "",
  "type": "",
  "description": "",
  "created_at": "",
  "seen": false
}

Properties

Name	Type	Required	MaxLength	MinLength	Description	Pattern
id	string	false	none	none	none	none
summary	string	false	none	none	none	none
type	string	false	none	none	none	none
description	string	false	none	none	none	none
created_at	string	false	none	none	none	none
seen	boolean	false	none	none	none	none