SdkConfigurationProperty

A configuration property of an SDK type.

APIs.ioEngineeringPlatform

Properties

Name Type Description
name object
friendlyName object
description object
required object
defaultValue object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-sdkconfigurationproperty-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SdkConfigurationProperty",
  "title": "SdkConfigurationProperty",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of a an SdkType configuration property."
        }
      ]
    },
    "friendlyName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The user-friendly name of an SdkType configuration property."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The description of an SdkType configuration property."
        }
      ]
    },
    "required": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (<code>true</code>) or not (<code>false</code>)."
        }
      ]
    },
    "defaultValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The default value of an SdkType configuration property."
        }
      ]
    }
  },
  "description": "A configuration property of an SDK type."
}