Manage OpenAPI documents with version 3 standards for a web application

You can upload and manage OpenAPI documents that follow version 3 standards for a web application. OpenAPI documents define the APIs that are available for API testing.

Before you begin

You must have completed the following tasks:

Ensured that you are assigned a role as a Project Owner or Tester in the project. See Managing access to the server projects.
Created a project in your team space in Test Hub. See Creating a project.

Added the remote Git repository that contains the test resources to the project. See Adding repositories to a server project.

Ensured that your project contains an application.

Procedure

Log in to Test Hub.
The Projects page of the initial team space is displayed.
Click My projects > project_name to open the project that contains the test assets.
The Overview page of the project is displayed.
Navigate to Author > Test Editor.
The Test Editor page and test navigator panel are displayed.
Select the Application in the test navigator panel and click Edit.
Alternatively, right-click the application in the test navigator panel and click Edit.

The Edit branch dialog is displayed.

If the Edit branch dialog is not displayed, then go to step 6.
Select your action to either select an existing Edit branch or create an Edit branch:
- Perform the following steps to select an existing Edit branch:
  1. Select Use an existing edit branch.
  2. Select an Edit branch from the Select branch list if Edit branches already exist for your repository.
    
    Note:
    A warning message is displayed if the Edit branch, you selected is behind the source branch. To update the selected edit branch and maintain synchronization with the source branch, you can select the Update branch option when switching checkbox.
  3. Click Ok.
- Perform the following steps to create the Edit branch:
  1. Select Create new edit branch.
  2. Enter a name for the Edit branch in the Branch Name field.
  3. Click Save.
Click the APIs tab.
Click Add APIs.
The Upload dialog is displayed.
Click Select files and select one or more OpenAPI documents in JSON or YAML format.

The selected documents are displayed in the Upload dialog box.

Test Hub validates each document. The document must contain the required OpenAPI version and title information. An error indicator and a description of the validation error are displayed for documents that do not meet the validation requirements.
Click Upload.

The uploaded OpenAPI documents are displayed in the APIs tab with information such as the API title and description.

An APIs virtual folder is created in the left navigator, and the uploaded documents are displayed in the folder.
Select the document that you want to delete and click the Delete icon to delete an OpenAPI document.

The Delete dialog is displayed.
Select the dependencies that you want to delete along with the OpenAPI document.
Click Delete.

The OpenAPI document and the selected dependencies are deleted. The document is removed from the APIs tab, and from the virtual folder in the left navigator.

Results

You have uploaded and managed OpenAPI documents for the web application.

Note:

External URLs are not currently supported for OpenAPI schemas. Upload and manage OpenAPI documents within the project to support change management and prevent unexpected breakages.