search

Open-Network-Models-and-Interfaces-ONMI / TAPI

LF ONMI Transport API Repository (TAPI)
https://github.com/Open-Network-Models-and-Interfaces-ONMI/TAPI/wiki
Apache License 2.0
95 stars 80 forks source link

YANG to OAS tool does not generate GET with potentially multiple replies #497

Closed amazzini closed 4 months ago

amazzini commented 3 years ago

Some “get all of” listed in TR-547 https://www.opennetworking.org/wp-content/uploads/2020/08/TR-547-TAPI-v2.1.3-Reference-Implementation-Agreement-1.pdf - Table 3, e.g.

/data/tapi-common:context/service-interface-point/
/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service/

in the yaml are not present, i.e. there is only the GET of single SIP/ConnServ, identified by uuid. GET operations to retrieve multiple elements are allowed if the response encoding is based on JSON. In case of XML encoding, a dedicated container is necessary for the multiple replies, while not for JSON. IETF reference https://tools.ietf.org/html/rfc8040#section-4.3: "If any content is returned to the client, then the server MUST send a valid response message-body. More than one element MUST NOT be returned for XML encoding. If multiple elements are sent in a JSON message-body, then they MUST be sent as a JSON array." Assumed that recommended encoding is JSON, the yang2oas tool shall include the GET with multiple replies.

amazzini commented 4 months ago

This issue has been closed due to the lack of activity for more than one year. Please reopen it if follow up is necessary.