RulesetsByDocumentsResponseList

API GatewayAPI ManagementDeveloper PortalDeveloper ToolsIBM

Properties

Name	Type	Description
tags	object
results	array
total_results	integer

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-rulesets-by-documents-response-list-schema.json",
  "title": "RulesetsByDocumentsResponseList",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-rulesets-and-rules-api-openapi.yml#/components/schemas/RulesetsByDocumentsResponseList",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "tags": {
      "type": "object"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/RulesetResponse"
      }
    },
    "total_results": {
      "type": "integer"
    }
  },
  "$defs": {
    "ResourceVisibility": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "public",
            "private",
            "custom"
          ]
        },
        "org_urls": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "RuleResponse": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 65535
        },
        "message": {
          "type": "string"
        },
        "recommended": {
          "type": "boolean"
        },
        "type": {
          "type": "string"
        },
        "given": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "severity": {
          "type": "string",
          "enum": [
            "error",
            "warn",
            "info",
            "hint",
            "off"
          ]
        },
        "formats": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "oas2",
              "oas3",
              "oas3_0",
              "oas3_1",
              "aas2",
              "aas3_0"
            ]
          }
        },
        "resolved": {
          "type": "boolean"
        },
        "then": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "id": {
          "type": "string",
          "readOnly": true
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "url": {
          "type": "string",
          "readOnly": true,
          "format": "uri"
        }
      }
    },
    "RulesetResponse": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "ruleset_version": {
          "type": "string",
          "maxLength": 255
        },
        "description": {
          "type": "string",
          "maxLength": 65535
        },
        "ruleset_type": {
          "type": "string",
          "enum": [
            "global-ibm",
            "global-spectral",
            "global-custom",
            "custom"
          ]
        },
        "ruleset_format_type": {
          "type": "string"
        },
        "visibility": {
          "$ref": "#/$defs/ResourceVisibility"
        },
        "rules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RuleResponse"
          }
        },
        "id": {
          "type": "string",
          "readOnly": true
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "url": {
          "type": "string",
          "readOnly": true,
          "format": "uri"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema 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 Schema

curl "https://apis.io/api/v1/json-schemas/ibm-api-connect-rulesets-by-documents-response-list"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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