For the old Open API Profile used for the REST Server and Client agents in Image Addedversions before 8.1.8.0, see /wiki/spaces/MD82/pages/3783710.
...
Warning
title
Warning!
If you have been using the Open API Profile before Image Addedversion 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
Image RemovedImage Added
Open API Profile Configuration
Setting
Description
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
title
The 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
title
Info!
When UDRs are generated from the OpenAPI specification file, some UDR fields found in the response body are marked as read-only. This prevents the HTTP/2 Server from setting those fields in APL to generate a proper response.
Selecting this checkbox, allows the HTTP/2 Server agents to be able to set the read-only fields in APL for use cases that require a response from the HTTP/2 Server agent.
Note
title
Refreshing 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.
Note
title
Note
Field names in the yaml specification file containing symbols below will replaced with unique string of characters during the UDR generation process. @ -> _40_ . -> _2E_ - -> _2D_ For example the field "test-name" will be converted into "test_2D_name" as a UDR.
All tab indentations found in the Open API yaml files will be replaced with two spaces.
View Included Files Tab
Setting
Description
Included Files
A 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 oneOftag 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: