@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": "integer" }, "enableThrottledRetries": { "type": "boolean" }, "enableKeepAlive": { "type": "boolean" }, "enableResponseMetadataCache": { "type": "boolean" }, "signatureAlgorithm": { "type": "string" }, "tcpSendBufferSizeHint": { "type": "integer" }, "tcpReceiveBufferSizeHint": { "type": "integer" } } }, "extensions": { "type": "object", "properties": { "webm-gateway": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "default": "wm_1.0.0" }, "spec": { "type": "object", "additionalProperties": false, "properties": { "condition": { "type": "string" }, "lambdaConfig": { "type": "object", "additionalProperties": false, "properties": { "alias": { "type": "string" } } }, "clientConfig": { "type": "object", "additionalProperties": false, "properties": { "retryOnErrorCount": { "type": "integer" } } }, "request_processing": { "description": "Field 'request_processing' with JSON name 'request-processing' accepts the value of either 'request_processing' or 'request-processing' from the YAML file. If both are specified, 'request-processing' takes priority.\n", "type": "object", "additionalProperties": false, "required": [ "transformations" ], "properties": { "transformations": { "description": "Single instance of transformation can be given", "type": "object", "additionalProperties": false, "properties": { "set": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "remove": { "type": "array", "items": { "type": "string" } }, "setPayload": { "type": "object", "additionalProperties": false, "properties": { "content-types": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "defaultContentType": { "type": "string" }, "xsl": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "$path": { "type": "string" }, "content": { "type": "string" }, "feature": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } }, "useIncomingHeaders": { "type": "boolean" } } }, "response_processing": { "description": "Field 'response_processing' with JSON name 'response-processing' accepts the value of either 'response_processing' or 'response-processing' from the YAML file. If both are specified, 'response-processing' takes priority.\n", "type": "object", "additionalProperties": false, "required": [ "transformations" ], "properties": { "transformations": { "type": "object", "additionalProperties": false, "properties": { "abortAPIExecutionForFailure": { "type": "boolean" }, "copyEntireResponse": { "type": "boolean" }, "set": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "namespaces": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "properties": { "URI": { "type": "string" }, "prefix": { "type": "string" } } } } } } } } } } } } } }, "api.ibm.com_v1_validateapispecification.json": { "description": "The validate API Specification related information is captured in the message validateAPISpecification.\n", "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "ValidateAPISpecification" ], "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": [ "input", "validate" ], "properties": { "input": { "type": "string", "enum": [ "request", "response", "message" ] }, "validate": { "oneOf": [ { "required": [ "request" ], "properties": { "request": { "type": "object", "properties": { "schema": { "type": "object", "properties": { "validate": { "type": "boolean" } } }, "query": { "type": "boolean" }, "path": { "type": "boolean" }, "header": { "type": "boolean" }, "cookie": { "type": "boolean" }, "contentType": { "type": "boolean" } } } } }, { "required": [ "response" ], "properties": { "response": { "type": "object", "properties": { "schema": { "type": "object", "properties": { "validate": { "type": "boolean" } } }, "header": { "type": "boolean" }, "contentType": { "type": "boolean" } } } } }, { "required": [ "openApiSchemaRef" ], "properties": { "openApiSchemaRef": { "type": "object", "required": [ "schemaReference", "failureStatusCode" ], "properties": { "schemaReference": { "type": "string" }, "failureStatusCode": { "type": "string", "enum": [ "400", "500" ] } } } } }, { "required": [ "file" ], "properties": { "file": { "type": "object", "required": [ "$path", "failureStatusCode" ], "properties": { "$path": { "type": "string" }, "failureStatusCode": { "type": "string", "enum": [ "400", "500" ] } } } } } ] }, "extensions": { "type": "object", "properties": { "webm-gateway": { "type": "object", "required": [ "apiVersion", "spec" ], "properties": { "apiVersion": { "type": "string" }, "spec": { "type": "object", "properties": { "validate": { "type": "object", "properties": { "custom-headers": { "type": "object", "properties": { "condition": { "type": "string" } } }, "schema": { "type": "object", "properties": { "feature": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "boolean" } } } } } } } } } } } } } } } } } }, "api.ibm.com_v1_loadbalancer.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "LoadBalancer" ], "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, "oneOf": [ { "required": [ "roundRobinHttp" ] }, { "required": [ "weightedRandomHttp" ] } ], "properties": { "input": { "type": "string" }, "output": { "type": "string" }, "weightedRandomHttp": { "type": "object", "additionalProperties": false, "properties": { "verb": { "type": "string" }, "statusException": { "type": "array", "items": { "type": "object", "properties": { "pattern": { "type": "string" } } } }, "endpoints": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "endpoint" ], "properties": { "endpoint": { "type": "object", "properties": { "name": { "type": "string" }, "tlsClientProfile": { "type": "string" }, "url": { "type": "string" }, "urlType": { "type": "string", "enum": [ "plain", "variables", "jsonata", "distributedVariable" ] }, "version": { "type": "string", "enum": [ "HTTP/1.0", "HTTP/1.1", "HTTP/2" ] }, "timeout": { "type": "integer" }, "compressRequest": { "type": "string", "enum": [ "gzip", "br", "deflate", "none" ] }, "decompressResponse": { "type": "boolean" }, "followRedirects": { "type": "boolean" }, "chunkedUpload": { "type": "boolean" }, "persistentConnections": { "type": "boolean" } } }, "suspendTimeout": { "type": "integer" }, "weight": { "type": "integer" } } } } } }, "roundRobinHttp": { "type": "object", "additionalProperties": false, "properties": { "verb": { "type": "string" }, "statusException": { "type": "array", "items": { "type": "object", "required": [ "pattern" ], "properties": { "pattern": { "type": "string", "pattern": "^[0-9*]{3}$", "additionalProperties": false } } } }, "endpoints": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "endpoint" ], "additionalProperties": false, "properties": { "suspendTimeout": { "type": "integer" }, "endpoint": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "tlsClientProfile": { "type": "string" }, "url": { "type": "string" }, "urlType": { "type": "string", "enum": [ "plain", "variables", "jsonata", "distributedVariable" ] }, "compressRequest": { "type": "string", "enum": [ "br", "gzip", "deflate", "none" ] }, "version": { "type": "string", "enum": [ "HTTP/1.0", "HTTP/1.1", "HTTP/2" ] }, "timeout": { "type": "integer" }, "decompressResponse": { "type": "boolean", "default": false }, "followRedirects": { "type": "boolean", "default": false }, "chunkedUpload": { "type": "boolean" }, "persistentConnections": { "type": "boolean" } } } } } } } }, "extensions": { "type": "object", "properties": { "webm-gateway": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "default": "wm_1.0.0" }, "spec": { "type": "object", "additionalProperties": false, "properties": { "endpoints": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "connectionTimeout": { "type": "integer" }, "sslConfig": { "type": "object", "additionalProperties": false, "properties": { "keyStoreAlias": { "type": "string" }, "keyAlias": { "type": "string" }, "trustStoreAlias": { "type": "string" } } }, "serviceRegistryParameters": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } } } } } } } }, "api.ibm.com_v1_invoke.json": { "type": "object", "required": [ "kind", "apiVersion", "metadata", "spec" ], "additionalProperties": false, "properties": { "kind": { "enum": [ "Invoke" ], "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": [ "endpoint" ], "properties": { "cache": { "type": "object", "properties": { "expire": { "oneOf": [ { "type": "object", "required": [ "fromMessageHeader" ], "properties": { "fromMessageHeader": { "type": "object", "required": [ "headerName", "messageName" ], "properties": { "headerName": { "type": "string" }, "messageName": { "type": "string" } } } }, "additionalProperties": false }, { "type": "object", "required": [ "fromVariable" ], "properties": { "fromVariable": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } }, "additionalProperties": false }, { "type": "object", "required": [ "fromCacheControl" ], "properties": { "fromCacheControl": { "type": "object", "required": [ "messageName" ], "properties": { "messageName": { "type": "string" } } } }, "additionalProperties": false }, { "type": "object", "required": [ "static" ], "properties": { "static": { "type": "object", "required": [ "seconds" ], "properties": { "seconds": { "type": "integer", "format": "uint64", "minimum": 0 } } } }, "additionalProperties": false } ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "narrowScope" ], "properties": { "narrowScope": { "type": "object" } }, "additionalProperties": false }, { "type": "object", "required": [ "wideScope" ], "properties": { "wideScope": { "type": "object" } }, "additionalProperties": false } ] } }, "additionalProperties": false }, "endpoint": { "oneOf": [ { "type": "object", "required": [ "http" ], "properties": { "http": { "type": "object", "required": [ "target" ], "properties": { "statusException": { "type": "array", "items": { "type": "object", "required": [ "pattern" ], "properties": { "pattern": { "type": "string", "pattern": "^[0-9*]{3}$" } }, "additionalProperties": false } }, "target": { "type": "object", "required": [ "url" ], "properties": { "persistentConnections": { "type": "boolean", "default": true }, "timeout": { "type": "integer", "format": "uint64", "minimum": 0, "default": 20 }, "tlsClientProfile": { "type": "string" }, "url": { "type": "string" }, "decompressResponse": { "type": "boolean", "default": false }, "followRedirects": { "type": "boolean", "default": false }, "chunkedUpload": { "type": "boolean", "default": false }, "urlType": { "type": "string", "enum": [ "plain", "variables", "jsonata", "distributedVariable" ] }, "compressRequest": { "type": "string", "enum": [ "br", "gzip", "deflate", "none" ] }, "version": { "type": "string", "enum": [ "HTTP/1.0", "HTTP/1.1", "HTTP/2" ] } }, "additionalProperties": false }, "verb": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } ] }, "input": { "type": "string" }, "output": { "type": "string" }, "extensions": { "type": "object", "additionalProperties": false, "properties": { "webm-gateway": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string" }, "spec": { "type": "object", "additionalProperties": false, "properties": { "endpoint": { "type": "object", "properties": { "http": { "type": "object", "additionalProperties": false, "properties": { "target": { "type": "object", "additionalProperties": false, "properties": { "connectionTimeout": { "type": "integer" } } }, "sslConfig": { "type": "object", "additionalProperties": false, "properties": { "keyStoreAlias": { "type": "string" }, "keyAlias": { "type": "string" }, "trustStoreAlias": { "type": "string" } } }, "serviceRegistryParameters": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } } } } } } } } }, "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", "