YAML

Download Spec

Get Yaml By id

get /yaml/{yaml_id}

API Key ApiKey

X-API-Key found in header

yaml_id

string

required

Response

Examples Schema

Successful Response

{
  "name": "string",
  "yaml": "string",
  "published": true,
  "prod_id": "string",
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z"
}

Validation Error

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

name

string

yaml

string

required

published

boolean

Default
false

prod_id

string

id

string

required

tpp_id

string

required

created

string

date-time

required

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Update Tpp Yaml

post /yaml/{yaml_id}

API Key ApiKey

X-API-Key found in header

yaml_id

string

required

name

string

yaml

string

required

published

boolean

Default
false

prod_id

string

Request

{
  "name": "string",
  "yaml": "string",
  "published": true,
  "prod_id": "string"
}

Response

Examples Schema

Successful Response

{
  "name": "string",
  "yaml": "string",
  "published": true,
  "prod_id": "string",
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z"
}

Validation Error

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

name

string

yaml

string

required

published

boolean

Default
false

prod_id

string

id

string

required

tpp_id

string

required

created

string

date-time

required

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Delete Yaml for TPP

delete /yaml/{yaml_id}

API Key ApiKey

X-API-Key found in header

yaml_id

string

required

Response

Examples Schema

Successful Response

Empty response

Validation Error

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

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Get all Yaml files for given TPP

get /yaml

API Key ApiKey

X-API-Key found in header

published

boolean

page

integer

Default
0

size

integer

Default
50

Response

Examples Schema

Successful Response

{
  "items": [
    {
      "name": "string",
      "yaml": "string",
      "published": true,
      "prod_id": "string",
      "id": "string",
      "tpp_id": "string",
      "created": "2023-06-07T17:32:28Z"
    }
  ],
  "total": null,
  "page": null,
  "size": 123
}

Validation Error

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

items

array[object (TppYaml)]

required

TppYaml

object (TppYaml)

name

string

yaml

string

required

published

boolean

Default
false

prod_id

string

id

string

required

tpp_id

string

required

created

string

date-time

required

total

integer

required

page

integer

required

size

int

required

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create Yaml for given TPP

post /yaml

API Key ApiKey

X-API-Key found in header

name

string

yaml

string

required

published

boolean

Default
false

prod_id

string

Request

{
  "name": "string",
  "yaml": "string",
  "published": true,
  "prod_id": "string"
}

Response

Examples Schema

Successful Response

{
  "name": "string",
  "yaml": "string",
  "published": true,
  "prod_id": "string",
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z"
}

Validation Error

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

name

string

yaml

string

required

published

boolean

Default
false

prod_id

string

id

string

required

tpp_id

string

required

created

string

date-time

required

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Was this page helpful?