Open APIs

 View Only
Expand all | Collapse all

Replacement of "/listener" to native callbacks in OAS 3.x in TMF OpenAPI v5?

  • 1.  Replacement of "/listener" to native callbacks in OAS 3.x in TMF OpenAPI v5?

    Posted Oct 03, 2022 02:13
    Hi all,
    I can see there are some OpenAPI's v5 in the "Early Adoption Table" which are specified in OAS v3.x now, but the first thing I've noticed while scrolling through them (e.g. TMF674 Geographic Site Management here: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/5.0.0/swagger/TMF674-GeographicSite-v5.0.0.oas.yaml, line 128) is that there are these "/listener hacks" being used in these specifications to specify the consumer notification callbacks when there is now an actual standard feature dedicated ("callbacks" object under the response - https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.1.md#callbackObject) for specifying callbacks like this in the OAS 3.x.
    What I'm wondering is if TMF OpenAPIs will continue use this "/listener hack" for some reason or are they planned to be migrated over to the native callbacks feature of OAS 3.0 at some point?

    ------------------------------
    Justas Vilimas
    Telia Company
    ------------------------------


  • 2.  RE: Replacement of "/listener" to native callbacks in OAS 3.x in TMF OpenAPI v5?

    Posted Oct 03, 2022 03:02
    Thanks Justas for calling this out.
    I'll bring it to the Open API team's attention.
    In parallel, please note that there is a research track looking at asyncAPI, which may provide a still more robust expression for asynchronous point-to-point semantics.

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------