FunctionDefinition

The function definition.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
name	string	The name of the function to be called.
description	string	A description of what the function does.
parameters	object	The parameters the functions accepts, described as a JSON Schema object.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FunctionDefinition",
  "title": "FunctionDefinition",
  "type": "object",
  "description": "The function definition.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the function to be called.",
      "example": "Example Title"
    },
    "description": {
      "type": "string",
      "description": "A description of what the function does.",
      "example": "A sample description."
    },
    "parameters": {
      "type": "object",
      "description": "The parameters the functions accepts, described as a JSON Schema object.",
      "example": "example_value"
    }
  },
  "required": [
    "name"
  ]
}