Open API (3.1)

Owned by Jenni Wallin
Last updated: Aug 09, 2023 by Former user (Deleted)
3 min read

If you want to use Open API 3.0 with HTTP/2 agents, you require an Open API profile configuration. You select the profile that you configure in the HTTP/2 Server agent configuration. In the Open API profile configuration, you import your OpenAPI specification file and view any other included files defined by the specification.

  • All schemas that require a UDR must be named. Due to a limitation in the third party parsing library used by OpenAPI, unnamed schemas cannot be detected and will not generate a corresponding UDR. Therefore, you must name all schemas that require a UDR.

  • Field names in the yaml specification file containing the following symbols will be replaced with unique string of characters during the UDR generation process as shown below:

    • @ -> _40_

    • . -> _2E_

    • - -> _2D_

For example, the field "test-name" will be converted into "test_2D_name" as a UDR.

The OpenAPI profile consists of two tabs: Configuration and View Included Files.

Configuration Tab

Open API Configuration tab

Setting

Description

Import

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.

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!

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

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



Limitations 

This section lists the limitations that users may encounter when using the OpenAPI profile.

OpenAPI specification schema which contains 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:

Example: SubscriptionData schema contains the subscrCond with oneOf tag

SubscriptionData:       description: Information of a subscription to notifications to NRF events, included in subscription requests and responses       type: object       required:         - nfStatusNotificationUri         - subscriptionId       properties:         nfStatusNotificationUri:           type: string         reqNfInstanceId:           $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'         subscrCond:           oneOf:             - $ref: '#/components/schemas/NfInstanceIdCond'             - $ref: '#/components/schemas/NfInstanceIdListCond'             - $ref: '#/components/schemas/NfTypeCond'             - $ref: '#/components/schemas/ServiceNameCond'             - $ref: '#/components/schemas/AmfCond'             - $ref: '#/components/schemas/GuamiListCond'             - $ref: '#/components/schemas/NetworkSliceCond'             - $ref: '#/components/schemas/NfGroupCond'             - $ref: '#/components/schemas/NfSetCond'             - $ref: '#/components/schemas/NfServiceSetCond'             - $ref: '#/components/schemas/UpfCond'             - $ref: '#/components/schemas/ScpDomainCond'             - $ref: '#/components/schemas/NwdafCond'             - $ref: '#/components/schemas/NefCond'

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

[openapi.issue_http.OAPI_NrfMgt.udr.SubscriptionData]   nfStatusNotificationUri: http://localhost/dummy   subscriptionId: 123456   subscrCond: {nfSetId=MU01}

Example: SubscriptionData schema decoded in the APL:

To retrieve the value of the map, enter the following code in APL:

string ID = mapGet((map<string, any>)subscriptionData.subscrCond, "nfSetId"); debug(ID);

The debug output is as follows:

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.