Workaround for "No Summary Defined" in LiveApps app using TCI deployed Service

Workaround for "No Summary Defined" in LiveApps app using TCI deployed Service

book

Article ID: KB0081857

calendar_today

Updated On:

Products Versions
TIBCO Cloud Live Apps -

Description

1. Create a simple API in TIBCO BusinessWorks (BW) or create an API in API Modeler and later implement it in BW.

2. Once you try to import it in LiveApps' app, it will give "No Summary defined" error. (For more information, please refer to the attachment (LiveApps Error.png))

Environment

TCI 1.20

Resolution

This is a known issue, and is being tracked in JIRAs for TCI and BW (IPAS-7422 and AMBW-30864). It is expected to be released with TCI 1.21 release.

Here are the current workarounds for the issue:

Workaround 1

1. Modify the service JSON inside service descriptors folder (<project_name>.module > Service Descriptors > <service_name>.json) to include the "summary" field, as shown in the example below:

"post": {
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Success response",
            "schema": {
              "type": "string"
            }
          }
        },
        "parameters": [],
        "operationId": "postResrouce3",
        "description": "POST OPERATION",
        "summary": "Summary for POST"
}

2. Repeat step 1, for all the service JSON files in the service descriptors folder.

3. Deploy the service by either using the "Push to Cloud" option (to push directly from Business Studio to Cloud), or by "Create Enterprise Archive (EAR)" option (to deploy using EAR file + MANIFEST.JSON in the cloud).

4. Now, you will be able to import the TCI service within the LiveApps app with no issues.


Or, alternatively, Workaround 2

1. Generate the EAR file by right clicking on the BWCE project > Create Enterprise Archive (EAR)

2. Add "summary" field in the MANIFEST.JSON file (generated along with EAR file in the same folder) for each of the REST operation(s), as shown in the example below:

 "post": {
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Success response",
            "schema": {
              "type": "string"
            }
          }
        },
        "parameters": [],
        "operationId": "postResrouce3",
        "summary": "Summary needed for LiveApps",
        "description": "POST OPERATION"
      }

For more details, please refer to the attachment (Summary_Description.png).

3. Delete the app scaled/deployed in the TCI. After that, scale/deploy the TCI app using the EAR file + MANIFEST.JSON (modified in step 2).

4. Now, you will be able to import the TCI service within the LiveApps app with no issues.

Issue/Introduction

Workaround for "No Summary Defined" in LiveApps app using TCI deployed Service

Attachments

Workaround for "No Summary Defined" in LiveApps app using TCI deployed Service get_app
Workaround for "No Summary Defined" in LiveApps app using TCI deployed Service get_app