Number

Number is a basic input for numeric data.

💡 Common number usage

The number input type can be used to store any numeric data, for example:

• Memory/storage allocations
• Replica counts
• Number of days to retain data

In the live demo self-service hub page, we can see the scaffold new service action whose K8s Replica Count input is a number input. 🎬

API definition

Basic

{
  "myNumberInput": {
    "title": "My number input",
    "icon": "My icon",
    "description": "My number input",
    "type": "number",
    "default": 7
  }
}

Select (Enum)

{
  "myNumberSelectInput": {
    "title": "My number select input",
    "icon": "My icon",
    "description": "My number select input",
    "type": "number",
    "enum": [1, 2, 3, 4]
  }
}

Array

{
  "myNumberArrayInput": {
    "title": "My number array input",
    "icon": "My icon",
    "description": "My number array input",
    "type": "array",
    "items": {
      "type": "number"
    }
  }
}

Enum Array

{
  "myNumberArray": {
    "title": "My number-selection array input",
    "icon": "My icon",
    "description": "My number-selection array input",
    "type": "array",
    "items": {
      "type": "number",
      "enum": [1, 2, 3, 4],
      "enumColors": {
        "1": "red",
        "2": "green",
        "3": "blue"
      }
    }
  }
}

Check out Port's API reference to learn more.

Terraform definition

Basic

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    number_props = {
      "myNumberInput" = {
        title       = "My number input"
        description = "My number input"
        default     = 7
      }
    }
  }
}

Select (Enum)

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    number_props = {
      "myNumberInput" = {
        title       = "My number input"
        description = "My number input"
        enum        = [1, 2, 3, 4]
      }
    }
  }
}

Array

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    array_props = {
      "myNumberArrayInput" = {
        title       = "My number array input"
        description = "My number array input"
        number_items = {}
      }
    }
  }
}

Validate number

Number validations support the following operators:

• range

Ranges of numbers are specified using a combination of the minimum and maximum keywords, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range).

If x is the value being validated, the following must hold true:

• x ≥ minimum
• x > exclusiveMinimum
• x ≤ maximum
• x < exclusiveMaximum

Basic

{
  "myNumberInput": {
    "title": "My number input",
    "icon": "My icon",
    "description": "My number input",
    "type": "number",
    "minimum": 0,
    "maximum": 50
  }
}

Array

{
  "myNumberArrayInput": {
    "title": "My number array input",
    "icon": "My icon",
    "description": "My number array input",
    "type": "array",
    "items": {
      "type": "number",
      "exclusiveMinimum": 0,
      "exclusiveMaximum": 50
    }
  }
}

Terraform

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    number_props = {
      "myNumberInput" = {
        title       = "My number input"
        description = "My number input"
        minimum     = 0
        maximum     = 50
      }
    }
  }
}