@apistudio/apim-cli

{ "api.ibm.com_v1_invokeawslambda.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "InvokeAWSLambda" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "description": "Defines a message named Metadata", "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "additionalProperties": false, "properties": { "functionName": { "description": "Name of the AWS Lambda function", "type": "string" }, "qualifier": { "description": "Version of the AWS Lambda function", "type": "string" }, "invocationType": { "type": "string", "enum": [ "requestResponse", "event" ] }, "region": { "type": "string" }, "awsAuthType": { "type": "object", "required": [ "accessSecret" ], "additionalProperties": false, "properties": { "accessSecret": { "type": "string" } } }, "tlsConnectionProfile": { "type": "string" }, "input": { "type": "string" }, "output": { "type": "string" }, "clientConfig": { "type": "object", "additionalProperties": false, "properties": { "socketTimeout": { "type": "integer" }, "connectionTimeout": { "type": "integer" }, "requestTimeout": { "type": "integer" }, "clientExecutionTimeout": { "type": "integer" }, "clientRetryCount": { "type": "integer" }, "connectionExpirationTimeout": { "type": "integer" }, "enableExpectContinue": { "type": "boolean" }, "enableGzip": { "type": "boolean" }, "enableHostPrefixInjection": { "type": "boolean" }, "maxConnectionIdleTime": { "type": "integer" }, "responseMetadataCacheSize": { "type": "boolean" }, "enableThrottledRetries": { "type": "boolean" }, "enableKeepAlive": { "type": "boolean" }, "enableResponseMetadataCache": { "type": "boolean" }, "signatureAlgorithm": { "type": "string" }, "tcpSendBufferSizeHint": { "type": "integer" }, "tcpReceiveBufferSizeHint": { "type": "integer" } } }, "extensions": { "type": "object", "properties": { "dp-nano-gateway": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "default": "lw_1.0.0" }, "spec": { "type": "object", "additionalProperties": false, "properties": { "clientConfig": { "type": "object", "additionalProperties": false, "properties": { "serverRetryCount": { "type": "integer" } } } } } } } } } } } } }, "api.ibm.com_v1_iam.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "IAM" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "description": "Defines a message named Metadata", "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "additionalProperties": false, "properties": { "accessControl": { "type": "array", "items": { "type": "array", "items": { "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "httpBasic": { "type": "object", "additionalProperties": false, "properties": { "applicationSecurity": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "authorize", "identify", "authenticate" ] } } }, "credentialLocation": { "type": "object", "properties": { "httpHeader": { "type": "object", "properties": { "name": { "type": "string" } } } } }, "credentialRegistry": { "type": "array", "items": { "type": "string" } }, "userGroupAuthorization": { "type": "object", "additionalProperties": false, "properties": { "requiredGroups": { "type": "array", "items": { "type": "string" } } } } } } } }, { "type": "object", "additionalProperties": false, "properties": { "apiKey": { "type": "object", "additionalProperties": false, "properties": { "applicationSecurity": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "authorize", "identify", "authenticate" ] } } }, "credentialLocation": { "type": "object", "properties": { "httpHeader": { "type": "object", "properties": { "name": { "type": "string" } } } } } } } } }, { "type": "object", "additionalProperties": false, "properties": { "oauth": { "type": "object", "additionalProperties": false, "properties": { "applicationSecurity": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "authorize", "identify", "authenticate" ] } } }, "credentialLocation": { "type": "object", "properties": { "httpHeader": { "type": "object", "properties": { "name": { "type": "string" } } } } }, "providers": { "type": "array", "items": { "type": "string" } }, "introspectionCredentials": { "type": "object", "additionalProperties": false, "properties": { "idHeader": { "type": "string" }, "secretheader": { "type": "string" } } }, "audClaim": { "type": "array", "items": { "type": "string" } }, "requiredScopes": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "provider": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } } } } } } }, { "type": "object", "additionalProperties": false, "properties": { "jwt": { "type": "object", "additionalProperties": false, "properties": { "applicationSecurity": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "authorize", "identify", "authenticate" ] } } }, "credentialLocation": { "type": "object", "properties": { "httpHeader": { "type": "object", "properties": { "name": { "type": "string" } } } } }, "providers": { "type": "array", "items": { "type": "string" } }, "requiredClaims": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "provider": { "type": "string" }, "claims": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } }, { "type": "object", "properties": { "hostname": { "type": "object", "additionalProperties": false, "properties": { "applicationSecurity": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "authorize", "identify", "authenticate" ] } } } } } } }, { "type": "object", "properties": { "ipAddress": { "type": "object", "additionalProperties": false, "properties": { "applicationSecurity": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "authorize", "identify", "authenticate" ] } } } } } } }, { "type": "object", "properties": { "certificate": { "type": "object", "additionalProperties": false, "properties": { "applicationSecurity": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "authorize", "identify", "authenticate" ] } } }, "credentialLocation": { "type": "object", "properties": { "httpHeader": { "type": "object", "properties": { "name": { "type": "string" } } } } } } } } }, { "type": "object", "properties": { "payloadElement": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" } } } } }, { "type": "object", "properties": { "httpHeaders": { "type": "object", "additionalProperties": false, "properties": { "applicationSecurity": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "authorize", "identify", "authenticate" ] } } }, "credentialLocation": { "type": "array", "items": { "type": "string" } } } } } } ] } } }, "extensions": { "type": "object", "properties": { "dp-nano-gateway": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "default": "lw_1.0.0" }, "spec": { "type": "object", "additionalProperties": false, "properties": { "securityNamespace": { "type": "string" }, "accessControl": { "type": "object", "additionalProperties": false, "properties": { "payloadElement": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "applicationSecurity": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "authorize", "identify", "authenticate" ] } } }, "credentialLocation": { "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "regex": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "properties": { "jsonata": { "type": "string" } } } ] } } } } } } } } } } } } } } } }, "api.ibm.com_v1_ratelimitdef.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "RateLimitDef" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "properties": { "consumerSpecific": { "type": "boolean" }, "dynamicValue": { "type": "string" }, "max": { "type": "integer" }, "intervalLen": { "type": "integer" }, "intervalUnit": { "type": "string", "enum": [ "second", "minute", "hour", "day", "week", "calendarweek", "calendarmonth" ] }, "extensions": { "type": "object", "properties": { "dp-nano-gateway": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "default": "lw_1.0.0" }, "spec": { "type": "object", "additionalProperties": false, "properties": { "weightExpr": { "type": "string" }, "dynamicValue": { "type": "string" }, "exceedAction": { "type": "string" }, "intervalOffset": { "type": "number" } } } } } } } } } } }, "api.ibm.com_v1_ratelimit.json": { "description": "The Throttling Policy related information is captured in the message ThrottlingPolicy", "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "RateLimit" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "additionalProperties": false, "properties": { "target": { "oneOf": [ { "type": "string", "default": "ALL" }, { "type": "object", "required": [ "specified" ], "properties": { "specified": { "type": "array", "items": { "type": "string" } } } } ] }, "limits": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": [ "limitDef" ], "properties": { "limitDef": { "type": "object", "additionalProperties": false, "required": [ "name", "definition" ], "properties": { "name": { "type": "string" }, "definition": { "type": "object", "required": [ "$ref" ], "additionalProperties": false, "properties": { "$ref": { "type": "string" } } }, "operation": { "type": "string", "enum": [ "update", "consume", "replenish", "check" ] } } } } } }, "extensions": { "type": "object", "properties": { "dp-nano-gateway": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "default": "lw_1.0.0" }, "spec": { "type": "object", "additionalProperties": false, "properties": { "limits": { "type": "array", "minItems": 1, "items": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "globalLimit" ], "properties": { "globalLimit": { "type": "object", "additionalProperties": false, "required": [ "name", "operation" ], "properties": { "name": { "type": "string" }, "operation": { "type": "string" } } } } }, { "type": "object", "additionalProperties": false, "required": [ "aliasLimit" ], "properties": { "aliasLimit": { "type": "object", "additionalProperties": false, "required": [ "name", "operation" ], "properties": { "name": { "type": "string" }, "operation": { "type": "string" } } } } } ] } } } } } } } } } } } }, "api.ibm.com_v1_ibmcloudlogin.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "IBMCloudLogin" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "description": "Defines a message named Metadata", "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "additionalProperties": false, "required": [ "apiKeySecret", "tlsClientProfile" ], "properties": { "message": { "type": "string" }, "apiKeySecret": { "type": "string" }, "tlsClientProfile": { "type": "string" } } } } }, "api.ibm.com_v1_watsonxaiinvoke.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "WatsonXAIInvoke" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "description": "Defines a message named Metadata", "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "additionalProperties": false, "properties": { "aiOperation": { "type": "string", "enum": [ "postTextGeneration", "postTextTokenization", "getFoundationModelSpecs" ] }, "aiOperationVersion": { "type": "string" }, "cacheScope": { "type": "string" }, "output": { "type": "string" }, "projectId": { "type": "string" }, "region": { "type": "string" }, "responseCacheExpiration": { "type": "integer" }, "responseCaching": { "type": "boolean" } } } } }, "api.ibm.com_v1_openaiinvoke.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "OpenAIInvoke" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "description": "Defines a message named Metadata", "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "additionalProperties": false, "properties": { "cacheScope": { "type": "string" }, "responseCaching": { "type": "boolean" }, "openAiOperation": { "type": "string", "enum": [ "postChatCompletions", "postEmbeddings", "getModels", "getModelsModel" ] }, "openApiKey": { "type": "string" }, "operationPathParameters": { "type": "string" }, "operationQueryParameters": { "type": "string" }, "organizationId": { "type": "string" }, "output": { "type": "string" }, "projectId": { "type": "string" }, "responseCacheExpiration": { "type": "integer" } } } } }, "api.ibm.com_v1_return.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "Return" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "description": "Defines a message named Metadata", "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "required": [ "level" ], "properties": { "level": { "type": "integer" } } } } }, "api.ibm.com_v1_retry.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "Retry" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "description": "Defines a message named Metadata", "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "properties": { "delay": { "type": "integer", "description": "Delay between retries in milliseconds", "minimum": 0 }, "retryOn": { "type": "array", "description": "List of error types that should trigger a retry", "items": { "type": "string", "enum": [ "BadRequestError", "CacheUnmetInputs", "CacheUnmetOutputs", "ConnectionError", "CorsRejectError", "CustomError", "ForbiddenError", "InternalError", "JsonataError", "JsonataNoMatchError", "LimitExceededError", "LuaScriptError", "MethodNotAllowedError", "NotFoundError", "NotImplementedError", "RedirectsExceeded", "ParseError", "TimeoutError", "SqlInjectionFilterError", "UnauthorizedError", "ValidateError", "ServiceUnavailableError" ] } }, "execute": { "type": "array", "items": { "type": "object", "required": [ "$ref" ], "additionalProperties": false, "properties": { "$ref": { "type": "string" } } } }, "maxRetries": { "type": "integer", "minimum": 0, "description": "Maximum number of retry attempts" } } } } }, "api.ibm.com_v1_throw.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "Throw" ], "type": "string" }, "apiVersion": { "type": "string", "default": "api.ibm.com/v1" }, "metadata": { "description": "Defines a message named Metadata", "type": "object", "required": [ "name", "version" ], "additionalProperties": false, "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "REST", "SWAGGER", "SOAP", "GRAPHQL", "ODATA" ] }, "version": { "type": "string" }, "labels": { "type": "object", "additionalProperties": true, "properties": { "gatewayTypes": { "type": "array", "items": { "type": "string" } } } } } }, "spec": { "type": "object", "required": [ "error" ], "properties": { "error": { "oneOf": [ { "type": "string", "enum": [ "BadRequestError", "ConnectionError", "CustomError", "LimitExceededError",