CreateModelRequest

Request to add a new Model to an existing RestApi resource.

APIs.ioEngineeringPlatform

Properties

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

JSON Schema

apis-io-engineering-platform-createmodelrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateModelRequest",
  "title": "CreateModelRequest",
  "type": "object",
  "required": [
    "name",
    "contentType"
  ],
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the model. Must be alphanumeric."
        }
      ]
    },
    "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."
        }
      ]
    },
    "contentType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The content-type for the model."
        }
      ]
    }
  },
  "description": "Request to add a new Model to an existing RestApi resource."
}