5G-MAG / Standards

Specifications related to 5G-MAG's areas of work. Tracking comments, bug-fixing, request for new features, etc.
https://www.5g-mag.com/standards
12 stars 4 forks source link

TS 26.512 - Use of Read-only mandatory fields in PolicyTemplate resource #88

Closed davidjwbbc closed 7 months ago

davidjwbbc commented 1 year ago

Description

The PolicyTemplate resource specified in TS 26.512 table 7.9.3-1 has several mandatory fields (Cardinality is 1..1) which are also read-only (all Usage operations are marked RO or -), meaning that they are only meaningful in API responses. The OpenAPI YAML specification in clause C.3.8 only marks these properties as being required meaning that the property is expected in both requests and responses. In fact, they should only be present in responses. In requests, these properties need to be ignored by the 5GMS AF.

There is therefore a discrepancy between table 7.9.3-1 and Annex C.3.8.

Suggested solution

Add the readOnly: true flag to the read-only mandatory fields in the OpenAPI YAML to signal that these fields are only required in an API response message, and will be ignored if present in an API request message.

Additional context

There are several other resources defined in TS 26.512 with mandatory fields that are also read-only and these should also be marked in the relevant OpenAPI YAML with the readOnly: true flag to improve the consistency between the Tables and the YAML.

davidjwbbc commented 1 year ago

This issue arose during implementing the feature while working on 5G-MAG/rt-5gms-application-function#70.

rjb1000 commented 11 months ago

Change Request addressing this issue endorsed during yesterday's 3GPP SA4 ad hoc call:

Revisions to be contributed to SA4#126 (Chicago).

rjb1000 commented 10 months ago

Change Requests agreed at SA4#126 (Chicago):

rjb1000 commented 7 months ago

CR Packs approved at SA#102 (Edinburgh):

rjb1000 commented 7 months ago