Schema Validation Request Body

APIs.ioEngineeringPlatform

Properties

Name Type Description
schema object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-schemasecurityvalidationrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/schemaSecurityValidationRequest",
  "title": "Schema Validation Request Body",
  "type": "object",
  "properties": {
    "schema": {
      "type": "object",
      "required": [
        "language",
        "schema",
        "type"
      ],
      "properties": {
        "language": {
          "type": "string",
          "description": "The definition format.",
          "enum": [
            "json",
            "yaml"
          ],
          "example": "json"
        },
        "schema": {
          "type": "string",
          "description": "The stringified API definition.",
          "example": "{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1\",\"title\":\"temp\",\"license\":{\"name\":\"MIT\"}},\"servers\":[{\"url\":\"https://petstore.swagger.io/v1\"}],\"paths\":{\"/user\":{\"get\":{\"summary\":\"Details about a user\",\"operationId\":\"listUser\",\"tags\":[\"user\"],\"parameters\":[{\"name\":\"id\",\"in\":\"query\",\"description\":\"ID of the user\",\"required\":true,\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}}],\"responses\":{\"200\":{\"description\":\"Details about a user\",\"headers\":{\"x-next\":{\"description\":\"A link to the next page of responses\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{$ref:\"#/components/schemas/User\"}}}},\"default\":{\"description\":\"unexpected error\",\"content\":{\"application/json\":{\"schema\":{$ref:\"#/components/schemas/Error\"}}}}}}}},\"components\":{\"schemas\":{\"User\":{\"type\":\"object\",\"required\":[\"id\",\"name\"],\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\"},\"tag\":{\"type\":\"string\"}}},\"Error\":{\"type\":\"object\",\"required\":[\"code\",\"message\"],\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"message\":{\"type\":\"string\"}}}},\"securitySchemes\":{\"BasicAuth\":{\"type\":\"http\",\"scheme\":\"basic\"}}},\"security\":[{\"BasicAuth\":[]}]}"
        },
        "type": {
          "type": "string",
          "description": "The definition type.",
          "enum": [
            "openapi3",
            "openapi2"
          ],
          "example": "openapi3"
        }
      }
    }
  }
}