Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note
titleNote!

For the old Open API Profile used for the REST Server and Client agents in Image Added versions before 8.1.8.0, see /wiki/spaces/MD82/pages/3783710.

...

Warning
titleWarning!

If you have been using the Open API Profile before Image Added version 8.1.8.0 and are using OpenAPI 2.0. You must convert from OpenAPI 2.0 to OpenAPI 3.0, before using the Open API Profile from   version 8.1.8.0 onwards.

Configuration Tab

Open API Profile Configuration

SettingDescription
Open API file

Import the OpenAPI specification file from where the desktop client is running. Upon successful import, the contents of the file will be displayed in the box below.

Warning
titleThe Web Desktop

If using the Web Desktop it is not possible to upload YAML files linked to other YAML files.


Ignore Read Only Tag

Select this option to ignore the readOnly tag in the specification file. 

Info
titleInfo!

When UDRs are generated from the OpenAPI specification file, some UDR fields found in the response body are marked as read-only. This prevent prevents the HTTP/2 Server from setting those fields in APL to generate a proper response.

By selecting Selecting this checkbox, it allows the HTTP/2 Server agents to be able to set the readOnly read-only fields in APL for use cases that require a response from the HTTP/2 Server agent.


...

Note
titleRefreshing the content.

To refresh the content of the imported API file or the contents of other included files, the imported file will have to be imported once again.

View Included Files Tab

SettingDescription
Included FilesA list of files that are referenced in the imported OpenAPI specification file will be shown here. Selecting from this list will have its contents be displayed in the box below.

Limitations 

This section lists the limitations that users may encounter when using the OpenAPI profile. OpenAPI specification schema which contains the oneOf tag will be decoded as a map instead of a UDR.

In the following example, the SubscriptionData schema contains the subscrCond property with oneOf tag:

...

The subscrCond is a schema of NfSetCond but it is decoded as a map with key-value pair as shown below:

...

The debug output is as follows:

Code Block
MU01


Scroll ignore
scroll-viewportfalse
scroll-pdftrue
scroll-officefalse
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse


Next: