Ruleset

A ruleset object.

APIs.ioEngineeringPlatform

Properties

Name Type Description
description string An informative description of the ruleset.
id object
last_updated string The timestamp of when the ruleset was last modified.
name string The human-readable name of the ruleset.
version object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-rulesets-ruleset-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/rulesets_Ruleset",
  "title": "Ruleset",
  "description": "A ruleset object.",
  "properties": {
    "description": {
      "default": "",
      "description": "An informative description of the ruleset.",
      "example": "My ruleset to execute managed rulesets",
      "title": "Description",
      "type": "string"
    },
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/rulesets_RulesetId"
        },
        {
          "readOnly": true
        }
      ]
    },
    "last_updated": {
      "description": "The timestamp of when the ruleset was last modified.",
      "example": "2000-01-01T00:00:00.000000Z",
      "format": "date-time",
      "readOnly": true,
      "title": "Last updated",
      "type": "string"
    },
    "name": {
      "description": "The human-readable name of the ruleset.",
      "example": "My ruleset",
      "minLength": 1,
      "title": "Name",
      "type": "string"
    },
    "version": {
      "$ref": "#/components/schemas/rulesets_RulesetVersion"
    }
  },
  "required": [
    "id",
    "version",
    "last_updated"
  ],
  "type": "object"
}