EnvironmentsFields

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/rivery/main/json-schema/rivery-environments-fields-schema.json",
  "title": "EnvironmentsFields",
  "description": "Environments properties to return.\n    ",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rivery-openapi.json#/components/schemas/EnvironmentsFields",
  "properties": {
    "_id": {
      "type": "string",
      "title": " Id",
      "description": "The environment id"
    },
    "account": {
      "type": "string",
      "title": "Account",
      "description": "The account id of the user"
    },
    "user_created": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "User Created",
      "description": "The user id of the user who first created the environment"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created At",
      "description": "The environment creation date time in UTC timezone. Time format YYYY-MM-DDThh:mm:ss.ms"
    },
    "cross_id": {
      "type": "string",
      "title": "Cross Id",
      "description": "The cross id of the environment"
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At",
      "description": "The time in which the environment was last updated (UTC time zone)"
    },
    "environment_name": {
      "type": "string",
      "title": "Environment Name",
      "description": "The environment name"
    },
    "color": {
      "allOf": [
        {
          "$ref": "#/$defs/EnvironmentsColorEnum"
        }
      ],
      "description": "The environment color as shown in the app",
      "default": "gray.400"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description",
      "description": "The environment description"
    },
    "variables": {
      "type": "object",
      "title": "Variables",
      "description": "Environment's variables"
    },
    "is_deleted": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Deleted",
      "description": "A flag that indicates whether the environment is deleted",
      "default": false
    },
    "deleted_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Deleted By",
      "description": "The user id of the user who deleted the environment (if the environment is deleted)"
    },
    "deleted_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Deleted At",
      "description": "The time in which the environment was deleted (if the environment is deleted). Time format YYYY-MM-DDThh:mm:ss.ms"
    },
    "is_default": {
      "type": "boolean",
      "title": "Is Default",
      "description": "A flag that indicates whether the environment is the account's default environment",
      "default": false
    },
    "updated_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated By",
      "description": "The user id of the user who last updated the environment"
    },
    "is_delete_lock": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Delete Lock",
      "description": "A flag that indicates the environment deletion progress"
    }
  },
  "type": "object",
  "required": [
    "_id",
    "account",
    "cross_id",
    "environment_name",
    "variables"
  ],
  "$defs": {
    "EnvironmentsColorEnum": {
      "type": "string",
      "enum": [
        "gray.400",
        "tagGreen",
        "cBlues",
        "tagCyan",
        "tagGeekBlue",
        "cPurples",
        "tagPurple",
        "tagMagenta",
        "cOranges",
        "tagOrange",
        "yellow.200"
      ],
      "title": "EnvironmentsColorEnum",
      "description": "The EnvironmentsColor enum provides all color options for environments"
    }
  }
}