Add Variant From Base And Config

POST 
/variants/from-base

Add a new variant based on an existing one. Same as POST /config

Args: payload (AddVariantFromBasePayload): Payload containing base variant ID, new variant name, and parameters. stoken_session (SessionContainer, optional): Session container. Defaults to result of verify_session().

Raises: HTTPException: Raised if the variant could not be added or accessed.

Returns: Union[AppVariantResponse, Any]: New variant details or exception.

Request

application/json

Body

required

base_id Base Id (string)required
new_variant_name New Variant Name (string)required
new_config_name New Config Name (string)required
parameters objectrequired

Responses

200

Successful Response

application/json

Schema

Schema

anyOf

AppVariantResponse_

app_id App Id (string)required

app_name App Name (string)required

variant_id Variant Id (string)required

variant_name Variant Name (string)required

parameters object

previous_variant_name Previous Variant Name (string)

user_id User Id (string)required

base_name Base Name (string)required

base_id Base Id (string)required

config_name Config Name (string)required

uri Uri (string)

revision Revision (integer)required

organization_id Organization Id (string)

workspace_id Workspace Id (string)

Example (from schema)

{}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

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

Loading...