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.
Info |
---|
For example, the field "test-name" will be converted into "test_2D_name" as a UDR.
|
Configuration
The Open API profile consists of the following tabs:
Table of Contents | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
General Tab
...
Setting | Description |
---|---|
Import | Imports the Open API specification file from the local file directory of the desktop or desktop client. Click on this button again after a file has been imported, to import another Open API specification file to overwrite the previously imported specification file. |
View | Opens the selected OPEN API schema file. |
Referenced Files | Lists the yaml files that are already imported into the Open API profile. Clicking on any of the records in the list will allow you to view the yaml file or remove it from the profile. Clicking on the Import button on the Reference Files will allow you to import the reference files for the main Open API specification file as well as any other reference files that are required. |
Importing Open API Specification Files
Users can choose to import or upload the yaml specification files via the following:
Browse and select from local directory
Drag and drop the file(s) to the Import Open API file dialog box
For any files that contain missing dependencies, you can choose to import or upload the referenced files via the following:
Browse and select from local directory
Drag and drop the file(s) to the Import referenced Open API file(s) dialog box
To view each Referenced file, select the .yaml file from the table and click View Schema.
To remove the .yaml file from the table, click Remove.
Advanced Tab
...
Setting | Description | ||
---|---|---|---|
Ignore Read Only Tag | Select this option to ignore the readOnly tag in the schema file.
| ||
Add “additionalProperties: false” to component schemas | Select this option to add the “additionalProperties: false” to each component in the schema file. |
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
Code Block |
---|
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:
Code Block |
---|
[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:
Code Block |
---|
string ID = mapGet((map<string, any>)subscriptionData.subscrCond, "nfSetId");
debug(ID); |
The debug output is as follows:
Code Block |
---|
MU01 |
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. |