update openapi.json with credentials APIs (#2323)

This commit is contained in:
Shuchang Zheng
2025-05-14 17:38:08 -07:00
committed by GitHub
parent 5781a53090
commit f4d2e415d2
53 changed files with 1803 additions and 148 deletions

View File

@@ -4,8 +4,8 @@ api:
specs:
- openapi: openapi/skyvern_openapi.json
origin: https://api.skyvern.com/openapi.json
# settings:
# use-title: false
settings:
title-as-schema-name: false
groups:
python-sdk:
generators:

View File

@@ -78,6 +78,8 @@
"mapping": {
"task_v1": "#/components/schemas/TaskRunResponse",
"task_v2": "#/components/schemas/TaskRunResponse",
"openai_cua": "#/components/schemas/TaskRunResponse",
"anthropic_cua": "#/components/schemas/TaskRunResponse",
"workflow_run": "#/components/schemas/WorkflowRunResponse"
}
},
@@ -1388,6 +1390,10 @@
"title": "Title",
"type": "string"
},
"engine": {
"$ref": "#/$defs/RunEngine",
"default": "skyvern-1.0"
},
"error_code_mapping": {
"anyOf": [
{
@@ -1605,6 +1611,16 @@
"title": "ProxyLocation",
"type": "string"
},
"RunEngine": {
"enum": [
"skyvern-1.0",
"skyvern-2.0",
"openai-cua",
"anthropic-cua"
],
"title": "RunEngine",
"type": "string"
},
"SendEmailBlockYAML": {
"properties": {
"block_type": {
@@ -2878,6 +2894,360 @@
"x-fern-sdk-method-name": "cancel_run"
}
},
"/v1/credentials": {
"get": {
"tags": [
"credentials"
],
"summary": "Get all credentials",
"description": "Retrieves a paginated list of credentials for the current organization",
"operationId": "get_credentials_v1_credentials_get",
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"description": "Page number for pagination",
"openapi_extra": {
"x-fern-sdk-parameter-name": "page"
},
"default": 1,
"title": "Page"
},
"description": "Page number for pagination",
"example": 1
},
{
"name": "page_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"description": "Number of items per page",
"openapi_extra": {
"x-fern-sdk-parameter-name": "page_size"
},
"default": 10,
"title": "Page Size"
},
"description": "Number of items per page",
"example": 10
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CredentialResponse"
},
"title": "Response Get Credentials V1 Credentials Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "credentials",
"x-fern-sdk-method-name": "get_credentials"
},
"post": {
"tags": [
"credentials"
],
"summary": "Create credential",
"description": "Creates a new credential for the current organization",
"operationId": "create_credential_v1_credentials_post",
"parameters": [
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCredentialRequest",
"description": "The credential data to create",
"openapi_extra": {
"x-fern-sdk-parameter-name": "data"
}
},
"example": {
"name": "My Credential",
"credential_type": "PASSWORD",
"credential": {
"username": "user@example.com",
"password": "securepassword123",
"totp": "JBSWY3DPEHPK3PXP"
}
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "credentials",
"x-fern-sdk-method-name": "create_credential"
}
},
"/v1/credentials/{credential_id}": {
"get": {
"tags": [
"credentials"
],
"summary": "Get credential by ID",
"description": "Retrieves a specific credential by its ID",
"operationId": "get_credential_v1_credentials__credential_id__get",
"parameters": [
{
"name": "credential_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The unique identifier of the credential",
"openapi_extra": {
"x-fern-sdk-parameter-name": "credential_id"
},
"title": "Credential Id"
},
"description": "The unique identifier of the credential",
"example": "cred_1234567890"
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "credentials",
"x-fern-sdk-method-name": "get_credential"
}
},
"/v1/credentials/{credential_id}/delete": {
"post": {
"tags": [
"credentials"
],
"summary": "Delete credential",
"description": "Deletes a specific credential by its ID",
"operationId": "delete_credential_v1_credentials__credential_id__delete_post",
"parameters": [
{
"name": "credential_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The unique identifier of the credential to delete",
"openapi_extra": {
"x-fern-sdk-parameter-name": "credential_id"
},
"title": "Credential Id"
},
"description": "The unique identifier of the credential to delete",
"example": "cred_1234567890"
},
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"name": "authorization",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-group-name": "credentials",
"x-fern-sdk-method-name": "delete_credential"
}
},
"/v1/browser_sessions/{browser_session_id}": {
"get": {
"tags": [
@@ -3298,6 +3668,10 @@
"title": "Title",
"default": ""
},
"engine": {
"$ref": "#/components/schemas/RunEngine",
"default": "skyvern-1.0"
},
"complete_criterion": {
"anyOf": [
{
@@ -4031,6 +4405,48 @@
],
"title": "ContextParameter"
},
"CreateCredentialRequest": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the credential",
"examples": [
"My Credential"
]
},
"credential_type": {
"$ref": "#/components/schemas/CredentialType",
"description": "Type of credential to create"
},
"credential": {
"anyOf": [
{
"$ref": "#/components/schemas/NonEmptyPasswordCredential"
},
{
"$ref": "#/components/schemas/NonEmptyCreditCardCredential"
}
],
"title": "Credential",
"description": "The credential data to store",
"examples": [
{
"password": "securepassword123",
"username": "user@example.com"
}
]
}
},
"type": "object",
"required": [
"name",
"credential_type",
"credential"
],
"title": "CreateCredentialRequest",
"description": "Request model for creating a new credential."
},
"CredentialParameter": {
"properties": {
"parameter_type": {
@@ -4100,6 +4516,87 @@
],
"title": "CredentialParameter"
},
"CredentialResponse": {
"properties": {
"credential_id": {
"type": "string",
"title": "Credential Id",
"description": "Unique identifier for the credential",
"examples": [
"cred_1234567890"
]
},
"credential": {
"anyOf": [
{
"$ref": "#/components/schemas/PasswordCredentialResponse"
},
{
"$ref": "#/components/schemas/CreditCardCredentialResponse"
}
],
"title": "Credential",
"description": "The credential data"
},
"credential_type": {
"$ref": "#/components/schemas/CredentialType",
"description": "Type of the credential"
},
"name": {
"type": "string",
"title": "Name",
"description": "Name of the credential",
"examples": [
"My Credential"
]
}
},
"type": "object",
"required": [
"credential_id",
"credential",
"credential_type",
"name"
],
"title": "CredentialResponse",
"description": "Response model for credential operations."
},
"CredentialType": {
"type": "string",
"enum": [
"password",
"credit_card"
],
"title": "CredentialType",
"description": "Type of credential stored in the system."
},
"CreditCardCredentialResponse": {
"properties": {
"last_four": {
"type": "string",
"title": "Last Four",
"description": "Last four digits of the credit card number",
"examples": [
"1234"
]
},
"brand": {
"type": "string",
"title": "Brand",
"description": "Brand of the credit card",
"examples": [
"visa"
]
}
},
"type": "object",
"required": [
"last_four",
"brand"
],
"title": "CreditCardCredentialResponse",
"description": "Response model for credit card credentials, containing only the last four digits and brand."
},
"DownloadToS3Block": {
"properties": {
"label": {
@@ -4174,6 +4671,10 @@
"title": "Title",
"default": ""
},
"engine": {
"$ref": "#/components/schemas/RunEngine",
"default": "skyvern-1.0"
},
"complete_criterion": {
"anyOf": [
{
@@ -4403,6 +4904,10 @@
"title": "Title",
"default": ""
},
"engine": {
"$ref": "#/components/schemas/RunEngine",
"default": "skyvern-1.0"
},
"complete_criterion": {
"anyOf": [
{
@@ -5011,6 +5516,10 @@
"title": "Title",
"default": ""
},
"engine": {
"$ref": "#/components/schemas/RunEngine",
"default": "skyvern-1.0"
},
"complete_criterion": {
"anyOf": [
{
@@ -5246,6 +5755,10 @@
"title": "Title",
"default": ""
},
"engine": {
"$ref": "#/components/schemas/RunEngine",
"default": "skyvern-1.0"
},
"complete_criterion": {
"anyOf": [
{
@@ -5434,6 +5947,119 @@
],
"title": "NavigationBlock"
},
"NonEmptyCreditCardCredential": {
"properties": {
"card_number": {
"type": "string",
"minLength": 1,
"title": "Card Number",
"description": "The full credit card number (must not be empty)",
"examples": [
"4111111111111111"
]
},
"card_cvv": {
"type": "string",
"minLength": 1,
"title": "Card Cvv",
"description": "The card's CVV (must not be empty)",
"examples": [
"123"
]
},
"card_exp_month": {
"type": "string",
"minLength": 1,
"title": "Card Exp Month",
"description": "The card's expiration month (must not be empty)",
"examples": [
"12"
]
},
"card_exp_year": {
"type": "string",
"minLength": 1,
"title": "Card Exp Year",
"description": "The card's expiration year (must not be empty)",
"examples": [
"2025"
]
},
"card_brand": {
"type": "string",
"minLength": 1,
"title": "Card Brand",
"description": "The card's brand (must not be empty)",
"examples": [
"visa"
]
},
"card_holder_name": {
"type": "string",
"minLength": 1,
"title": "Card Holder Name",
"description": "The name of the card holder (must not be empty)",
"examples": [
"John Doe"
]
}
},
"type": "object",
"required": [
"card_number",
"card_cvv",
"card_exp_month",
"card_exp_year",
"card_brand",
"card_holder_name"
],
"title": "NonEmptyCreditCardCredential",
"description": "Credit card credential model that requires non-empty values."
},
"NonEmptyPasswordCredential": {
"properties": {
"password": {
"type": "string",
"minLength": 1,
"title": "Password",
"description": "The password value (must not be empty)",
"examples": [
"securepassword123"
]
},
"username": {
"type": "string",
"minLength": 1,
"title": "Username",
"description": "The username associated with the credential (must not be empty)",
"examples": [
"user@example.com"
]
},
"totp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totp",
"description": "Optional TOTP (Time-based One-Time Password) string used to generate 2FA codes",
"examples": [
"JBSWY3DPEHPK3PXP"
]
}
},
"type": "object",
"required": [
"password",
"username"
],
"title": "NonEmptyPasswordCredential",
"description": "Password credential model that requires non-empty values."
},
"OutputParameter": {
"properties": {
"parameter_type": {
@@ -5543,6 +6169,24 @@
],
"title": "PDFParserBlock"
},
"PasswordCredentialResponse": {
"properties": {
"username": {
"type": "string",
"title": "Username",
"description": "The username associated with the credential",
"examples": [
"user@example.com"
]
}
},
"type": "object",
"required": [
"username"
],
"title": "PasswordCredentialResponse",
"description": "Response model for password credentials, containing only the username."
},
"ProxyLocation": {
"type": "string",
"enum": [
@@ -5572,7 +6216,8 @@
"enum": [
"skyvern-1.0",
"skyvern-2.0",
"openai-cua"
"openai-cua",
"anthropic-cua"
],
"title": "RunEngine"
},
@@ -5706,6 +6351,10 @@
"title": "Title",
"default": ""
},
"engine": {
"$ref": "#/components/schemas/RunEngine",
"default": "skyvern-1.0"
},
"complete_criterion": {
"anyOf": [
{
@@ -6142,14 +6791,28 @@
"title": "Modified At",
"description": "Timestamp when this run was last modified"
},
"app_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App Url",
"description": "URL to the application UI where the run can be viewed"
},
"run_type": {
"type": "string",
"enum": [
"task_v1",
"task_v2"
"task_v2",
"openai_cua",
"anthropic_cua"
],
"title": "Run Type",
"description": "Type of task run - either task_v1 or task_v2"
"description": "Types of a task run - task_v1, task_v2, openai_cua, anthropic_cua"
},
"run_request": {
"anyOf": [
@@ -6272,7 +6935,7 @@
"llm_key": {
"type": "string",
"title": "Llm Key",
"default": "AZURE_OPENAI"
"default": "AZURE_OPENAI_GPT4_1"
},
"prompt": {
"type": "string",
@@ -6418,6 +7081,10 @@
"title": "Title",
"default": ""
},
"engine": {
"$ref": "#/components/schemas/RunEngine",
"default": "skyvern-1.0"
},
"complete_criterion": {
"anyOf": [
{
@@ -6654,6 +7321,10 @@
"title": "Title",
"default": ""
},
"engine": {
"$ref": "#/components/schemas/RunEngine",
"default": "skyvern-1.0"
},
"complete_criterion": {
"anyOf": [
{
@@ -7516,6 +8187,18 @@
"title": "Modified At",
"description": "Timestamp when this run was last modified"
},
"app_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "App Url",
"description": "URL to the application UI where the run can be viewed"
},
"run_type": {
"type": "string",
"const": "workflow_run",