Add API

APIs.ioEngineeringPlatform

Properties

Name Type Description
api object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-pancreateapi-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/panCreateApi",
  "title": "Add API",
  "type": "object",
  "properties": {
    "api": {
      "type": "object",
      "required": [
        "id",
        "parentFolderId"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The API's ID.",
          "example": "5360b75f-447e-467c-9299-12fd6c92450d"
        },
        "parentFolderId": {
          "type": "integer",
          "description": "The API's parent folder ID.",
          "example": 1
        }
      }
    }
  }
}