...
| 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. | |||||
| View | Opens the selected OPEN API schema file. | |||||
| Ignore Read Only Tag | Select this option to ignore the readOnly tag in the specification file.
|
Limitations
This section lists the limitations that users may encounter when using the OpenAPI profile.
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.
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:
Example: SubscriptionData schema decoded in the APL:
| Code Block |
|---|
[openapi.issue_http.OAPI_NrfMgt.udr.SubscriptionData]
nfStatusNotificationUri: http://localhost/dummy
subscriptionId: 123456
subscrCond: {nfSetId=MU01} |
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); |
...