Skip to main content
Version: 3.8

Edit Overview

Editing an API involves modifying its endpoints, configurations, or functionalities to adapt to evolving requirements or enhance its performance and usability.

info

The REST, SOAP and GraphQL APIs are separated and shown in their own tabs, while all APIs are listed under the All tab.

Editapis

  1. Click the Respective API to edit it.

The Overview tab appears by default as shown below.

Editapis1

  1. Update the Short Description.

Editoverview

  1. Enter the Detail Description.
info

By default, the Version Notes appear as 1st Version.

  1. Update the Version Notes.

  2. Click Save as Draft.

info

Click Cancel to cancel the editing process.

On saving, the confirmation message appears as shown below.

saveoverview