Model

Represents the data structure of a method's request or response payload.

APIs.ioEngineeringPlatform

Properties

Name Type Description
id object
name object
description object
schema object
contentType object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-model-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Model",
  "title": "Model",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The identifier for the model resource."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the model. Must be an alphanumeric string."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The description of the model."
        }
      ]
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The schema for the model. For <code>application/json</code> models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail."
        }
      ]
    },
    "contentType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The content-type for the model."
        }
      ]
    }
  },
  "description": "Represents the data structure of a method's request or response payload."
}