WSO2 · JSON Structure

Governance Api Ruleset Info Structure

Detailed information about a ruleset.

Type: object Properties: 12 Required: 4
API ManagementGatewaysOpen-SourceAPI LifecycleGraphQLSOAPREST

RulesetInfo is a JSON Structure definition published by WSO2, describing 12 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name description ruleCategory ruleType artifactType documentationLink provider createdBy createdTime updatedBy updatedTime

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/governance-api-ruleset-info-structure.json",
  "name": "RulesetInfo",
  "description": "Detailed information about a ruleset.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the ruleset.",
      "readOnly": true,
      "example": "123e4567-e89b-12d3-a456-426614174000"
    },
    "name": {
      "type": "string",
      "description": "Name of the ruleset.",
      "example": "API Security Ruleset"
    },
    "description": {
      "type": "string",
      "description": "A brief description of the ruleset.",
      "example": "A ruleset designed to enforce security standards for APIs."
    },
    "ruleCategory": {
      "type": "string",
      "description": "Category the rules included in ruleset.",
      "enum": [
        "SPECTRAL"
      ],
      "example": "SPECTRAL"
    },
    "ruleType": {
      "type": "string",
      "description": "Context or area to which the ruleset applies.",
      "enum": [
        "API_METADATA",
        "API_DEFINITION",
        "API_DOCUMENTATION"
      ],
      "example": "API_DEFINITION",
      "x-enum-varnames": [
        "API_METADATA",
        "API_DEFINITION",
        "API_DOCUMENTATION"
      ]
    },
    "artifactType": {
      "type": "string",
      "description": "The type of artifact that the ruleset validates.",
      "enum": [
        "REST_API",
        "ASYNC_API",
        "MCP"
      ],
      "example": "REST_API"
    },
    "documentationLink": {
      "type": "string",
      "description": "URL to the documentation related to the ruleset.",
      "example": "https://example.com/docs/api-security-ruleset"
    },
    "provider": {
      "type": "string",
      "description": "Entity or individual providing the ruleset.",
      "example": "TechWave"
    },
    "createdBy": {
      "type": "string",
      "description": "Identifier of the user who created the ruleset.",
      "readOnly": true,
      "example": "admin@gmail.com"
    },
    "createdTime": {
      "type": "string",
      "description": "Timestamp when the ruleset was created.",
      "readOnly": true,
      "example": "2024-08-01T12:00:00Z"
    },
    "updatedBy": {
      "type": "string",
      "description": "Identifier of the user who last updated the ruleset.",
      "readOnly": true,
      "example": "admin@gmail.com"
    },
    "updatedTime": {
      "type": "string",
      "description": "Timestamp when the ruleset was last updated.",
      "readOnly": true,
      "example": "2024-08-02T12:00:00Z"
    }
  },
  "required": [
    "name",
    "ruleType",
    "artifactType",
    "provider"
  ]
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/governance-api-ruleset-info-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.