SuggestRequestBody

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/speakeasy/main/json-schema/speakeasy-suggest-request-body-schema.json",
  "title": "SuggestRequestBody",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/speakeasy-suggest-api-openapi.yml#/components/schemas/SuggestRequestBody",
  "type": "object",
  "properties": {
    "oas_summary": {
      "$ref": "#/$defs/OASSummary"
    },
    "suggestion_type": {
      "type": "string",
      "enum": [
        "method-names",
        "diagnostics-only"
      ]
    },
    "diagnostics": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Diagnostic"
      }
    }
  },
  "required": [
    "oas_summary",
    "suggestion_type",
    "diagnostics"
  ],
  "$defs": {
    "Diagnostic": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "Message describing the issue"
        },
        "path": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Schema path to the issue"
        },
        "type": {
          "type": "string",
          "description": "Issue type"
        },
        "helpMessage": {
          "type": "string",
          "description": "Help message for how to fix the issue"
        }
      },
      "required": [
        "message",
        "path",
        "type"
      ]
    },
    "OASInfo": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "summary": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "license": {
          "type": "object",
          "properties": {
            "identifier": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "title",
        "summary",
        "description",
        "version",
        "license"
      ]
    },
    "OASOperation": {
      "type": "object",
      "properties": {
        "method": {
          "type": "string"
        },
        "path": {
          "type": "string"
        },
        "operation_id": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "method_name_override": {
          "type": "string"
        },
        "group_override": {
          "type": "string"
        }
      },
      "required": [
        "method",
        "path",
        "operation_id",
        "description",
        "tags"
      ]
    },
    "OASSummary": {
      "type": "object",
      "properties": {
        "info": {
          "$ref": "#/$defs/OASInfo"
        },
        "operations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OASOperation"
          }
        }
      },
      "required": [
        "info",
        "operations"
      ]
    }
  }
}