Add a Schema

You can add schemas and save them to make calls to services that are not OpenAPI-compliant. The Workflow Hub supports OpenAPI 3.0 schemas. You can save schemas, associate a path to the schemas, and use this path to refer to them in workflows.

Procedure

1. Log in to the VMware Telco Cloud Automation.
2. Click Workflow Hub > Schemas.
3. Click Add Schema.
4. Enter the following information:
   • Path: Enter the path of the schema, which you can use while creating the workflow.
   • Description: (Optional) provide a description for the schema.
   • Schema: Enter the schema.
   • Type: Type of the schema. Can be one of Open API, Swagger, AsyncAPI, JSON.
   Following is a sample OpenAPI schema to create a cluster template:

   {
     "openapi": "3.0.0",
     "info": {
       "description": "Telco Cloud Automation Cluster Template API.",
       "version": "1.0",
       "title": "Telco Cloud Automation Cluster Template API.",
       "termsOfService": "https://www.vmware.com/content/dam/digitalmarketing/vmware/en/pdf/product/vmware-product-guide.pdf",
       "contact": {
         "name": "VMware"
       },
       "license": {
         "name": "Copyright (c) 2020-2021 VMware, Inc. All rights reserved."
       }
     },
     "servers": [
       {
         "url": "https://{tca}/telco/api",
         "variables": {
           "tca": {
             "default": "n/a",
             "description": "TCA IP"
           }
         }
       }
     ],
     "paths": {
       "/caas/internal/templates": {
         "get": {
           "tags": [
             "InfraClusterTemplate"
           ],
           "summary": "Api to get all cluster templates for Telco Cloud Automation",
           "description": "Api to get all cluster templates",
           "operationId": "getClusterTemplates",
           "parameters": [
             {
               "name": "filter",
               "in": "query",
               "description": "Attribute-based filtering expression.",
               "schema": {
                 "type": "string"
               }
             }
           ],
           "responses": {
             "200": {
               "description": "Get cluster templates"
             }
           }
         }
       }
     },
     "components": {
       "securitySchemes": {
         "x-hm-authorization": {
           "description": "Obtained from /hybridity/api/session",
           "type": "apiKey",
           "name": "x-hm-authorization",
           "in": "header"
         }
       }
     },
     "tags": [
       {
         "name": "ClusterTemplate",
         "description": "Telco Cloud Automation Cluste Template API"
       }
     ]
   }

5. Click Add.