Jump to

• Request
• Response

Get Default Settings for a Helm Chart Repository

get

/api/microservice/Catalogs/readForHelmchartValues

Gets the default values settings from the values.yaml for the specified Helm chart.

Request

Query Parameters

• Helmchart(required): string
  The name of the Helm chart package.

  Example:

  example-poller

• Version(required): string
  The version of the Helm chart.

  Example:

  6.0.3

• filter: object
  The fields to filter the results by. You cannot filter by fields that contain a state.
  This parameter's value uses the following JSON format:
  { "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
  If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

  • conjunction: string
    Default Value: OR

    Allowed Values: [ "AND", "OR" ]

    The conjunction between filters.

    Example: AND
  • operator: string
    Default Value: LIKE

    Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

    The filter operation to use.

    Example: eq
  • property(required): string
    The name of the field to filter on.

    Example: name
  • value(required): string
    The value of the field to filter on.

    Example: test

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• limit: integer(int32)
  The number of records to limit results by. If you do not also set the start parameter, records start at 0.

  Example:

  100

• sort: object
  The field and direction to sort results by. You cannot sort by fields that contain a state.
  This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

  • direction(required): string
    Allowed Values: [ "ASC", "DESC" ]

    The direction of the sort.

    Example: ASC
  • property(required): string
    The field to sort on.

    Example: name

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object",
      "example":[
          {
              "property":"Name",
              "direction":"ASC"
          },
          {
              "property":"Value",
              "direction":"DESC"
          }
      ]
  }

  Example:

  [
      {
          "property":"Name",
          "direction":"ASC"
      },
      {
          "property":"Value",
          "direction":"DESC"
      }
  ]

• start: integer(int32)
  The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

  Default Value: 0

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/components/schemas/microserviceCatalogsRead"
                            },
                            {
                                "type":"object",
                                "properties":{
                                    "customValues":{
                                        "description":"The custom values for the Helm chart.",
                                        "type":"string",
                                        "example":"\"# Default values for example-poller/n/nglobal:/n  imageRegistry: \"/\"/n/nreplicaCount: 1/n/nimage:/n  registry: \"/\"/n  repository: x/y\\n"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/microserviceCatalogsRead"
                    },
                    {
                        "type":"object",
                        "properties":{
                            "customValues":{
                                "description":"The custom values for the Helm chart.",
                                "type":"string",
                                "example":"\"# Default values for example-poller/n/nglobal:/n  imageRegistry: \"/\"/n/nreplicaCount: 1/n/nimage:/n  registry: \"/\"/n  repository: x/y\\n"
                            }
                        }
                    }
                ]
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/microserviceCatalogsRead"
            },
            {
                "type":"object",
                "properties":{
                    "customValues":{
                        "description":"The custom values for the Helm chart.",
                        "type":"string",
                        "example":"\"# Default values for example-poller/n/nglobal:/n  imageRegistry: \"/\"/n/nreplicaCount: 1/n/nimage:/n  registry: \"/\"/n  repository: x/y\\n"
                    }
                }
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object microserviceCatalogsRead
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/microserviceCatalogsRead"
        },
        {
            "type":"object",
            "properties":{
                "customValues":{
                    "description":"The custom values for the Helm chart.",
                    "type":"string",
                    "example":"\"# Default values for example-poller/n/nglobal:/n  imageRegistry: \"/\"/n/nreplicaCount: 1/n/nimage:/n  registry: \"/\"/n  repository: x/y\\n"
                }
            }
        }
    ]
}

Nested Schema : microserviceCatalogsRead

Type: object

Show Source

• apiVersion: string
  Version of the api

  Example: v1
• appVersion: string
  Version of the app

  Example: v6.0.3-0.0.54
• created: string
  Latest created timestamp of the app

  Example: 2023-10-18T05:02:25.841191421Z
• createdDate: string
  Latest created date of the app

  Example: 2023-10-18
• description: string
  Description of the microservice

  Example: Collects and processes data from example-poller
• icon: string
  Icon of the app

  Example: /resources/assure1/images/icons/microservice/app.png
• name: string
  Name of the microservice

  Example: example-poller
• urls: array urls
  urls
• version: string
  Version of Helm chart

  Example: 6.0.3

{
    "properties":{
        "apiVersion":{
            "description":"Version of the api",
            "type":"string",
            "example":"v1"
        },
        "appVersion":{
            "description":"Version of the app",
            "type":"string",
            "example":"v6.0.3-0.0.54"
        },
        "created":{
            "description":"Latest created timestamp of the app",
            "type":"string",
            "example":"2023-10-18T05:02:25.841191421Z"
        },
        "description":{
            "description":"Description of the microservice",
            "type":"string",
            "example":"Collects and processes data from example-poller"
        },
        "name":{
            "description":"Name of the microservice",
            "type":"string",
            "example":"example-poller"
        },
        "urls":{
            "description":"urls",
            "type":"array",
            "items":{
            },
            "example":[
                "example-poller-6.0.3.tgz"
            ]
        },
        "version":{
            "description":"Version of Helm chart",
            "type":"string",
            "example":"6.0.3"
        },
        "icon":{
            "description":"Icon of the app",
            "type":"string",
            "example":"/resources/assure1/images/icons/microservice/app.png"
        },
        "createdDate":{
            "description":"Latest created date of the app",
            "type":"string",
            "example":"2023-10-18"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• customValues: string
  The custom values for the Helm chart.

  Example: "# Default values for example-poller/n/nglobal:/n imageRegistry: "/"/n/nreplicaCount: 1/n/nimage:/n registry: "/"/n repository: x/y\n

{
    "type":"object",
    "properties":{
        "customValues":{
            "description":"The custom values for the Helm chart.",
            "type":"string",
            "example":"\"# Default values for example-poller/n/nglobal:/n  imageRegistry: \"/\"/n/nreplicaCount: 1/n/nimage:/n  registry: \"/\"/n  repository: x/y\\n"
        }
    }
}

Nested Schema : urls

Type: array

urls

Show Source

• Array of:

{
    "description":"urls",
    "type":"array",
    "items":{
    },
    "example":[
        "example-poller-6.0.3.tgz"
    ]
}

Example:

[
    "example-poller-6.0.3.tgz"
]

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top