api-shield_parameter_schemas_definition

An operation schema object containing a response.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
parameters	array	An array containing the learned parameter schemas.
responses	object	An empty response object. This field is required to yield a valid operation schema.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api-shield_parameter_schemas_definition",
  "title": "api-shield_parameter_schemas_definition",
  "description": "An operation schema object containing a response.",
  "example": {
    "parameters": [
      {
        "description": "Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.",
        "in": "path",
        "name": "var1",
        "required": true,
        "schema": {
          "maximum": 10,
          "minimum": 1,
          "type": "integer"
        }
      }
    ],
    "responses": null
  },
  "properties": {
    "parameters": {
      "description": "An array containing the learned parameter schemas.",
      "example": [
        {
          "description": "Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.",
          "in": "path",
          "name": "var1",
          "required": true,
          "schema": {
            "maximum": 10,
            "minimum": 1,
            "type": "integer"
          }
        }
      ],
      "items": {
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "responses": {
      "description": "An empty response object. This field is required to yield a valid operation schema.",
      "nullable": true,
      "readOnly": true,
      "type": "object"
    }
  },
  "readOnly": true,
  "type": "object"
}