Open APIs

Expand all | Collapse all

OpenAPI Specification 3.0

  • 1.  OpenAPI Specification 3.0

    TM Forum Member
    Posted Apr 15, 2020 02:38
    Hi, Is any plan when TMF Open API will support openapi spec 3.0?
    As I know open api spec 3.0 was released at middle of 2017, so I think that 2020 it is right time to support it.

    ------------------------------
    Sergey N Lukin
    Deutsche Telekom (Tel-IT)
    ------------------------------


  • 2.  RE: OpenAPI Specification 3.0

    TM Forum Member
    Posted Apr 20, 2020 01:46
    Hi Sergey
    Preparation work continues within the Open API team in order to support OAS 3.0 - we definitely want to be there.
    Perhaps @Pierre Gauthier or @Joel Burgess​​ can give additional insights into progress.
    Hope it helps

    ------------------------------
    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.
    ------------------------------



  • 3.  RE: OpenAPI Specification 3.0

    Posted May 04, 2021 09:34
    Hello there. I am co-chair of the OpenAPI Initiative (OAI), as well as the Chief Evangelist at Postman -- I'd love to talk more about your migration from Swagger 2.0 to OpenAPI 3.0, as well as the role Postman collections are playing -- I notice you use both.  i have been playing with the APIs, and establishing a sandbox for using them without an actual implementation, via a public workspace.

    ------------------------------
    Kin Lane
    TO BE VERIFIED
    ------------------------------



  • 4.  RE: OpenAPI Specification 3.0

    TM Forum Member
    Posted May 07, 2021 07:47
    Hi Kin,

    Thanks for your interest, the TMForum does extensively use Postman scripts as a "Conformance Test Kit" (CTK) for each TMF-API. We have a tool which generates this from the swagger + example payloads + a "conformance profile" (additional rules which cannot be reflected in swagger).

    Vendors who want to be "TMF API Certified" run the CTK against their own product. The CTK will exercise all swagger-defined mandatory operations, and assert any mandatory attributes or relationships are present in the associated responses. If your product survives these tests without a fail, it can be deemed to be compliant with that release of that API.

    Given that TMF APIs are quite lenient on mandatory operations/attributes/relationships - it can be debated whether this is a high or low "bar" - but it is at least an indication that the vendor/product are "on the same page".

    ------------------------------
    Stephen Harrop
    ------------------------------



  • 5.  RE: OpenAPI Specification 3.0

    TM Forum Member
    Posted May 07, 2021 07:59
    Just a further point on the Swagger and OASv3 files. The TMF maintains a schema repository (distinct JSON files in GitHub) that act as masters to all entities used across the API catalog (think: ProductOffering, TroubleTicket, ShoppingCart...). With the aid of a high-level DSL to describe each API, the swagger file is then constructed by a tool that draws on this DSL and the repository. This ensures consistent design patterns and terminology are used across the catalog.

    As Jonathan mentioned above @Joel Burgess is working on a clean-room refresh of this tool that constructs the same in OASv3 - taking the opportunity to exploit some of the new features available. This is a large-scale exercise that is being tested on a small set of TMF (and MEF) APIs for evaluation before embarking on the catalog-wide rollout during this year.

    @Pierre Gauthier is the TMF Chief API Architect​​​ overseeing this.

    ------------------------------
    Stephen Harrop
    ------------------------------



  • 6.  RE: OpenAPI Specification 3.0

    Posted May 19, 2021 18:58
    Hello Stephen,

    Thanks for info on your process -- great to hear.

    Also great to hear on the OASv3 refresh -- please let us know if we can help. Maybe when ready, we can do a blog post on that OAI / OAS blog about your standard? Feel free to stay in touch -- happy to support.

    ------------------------------
    Kin Lane
    TO BE VERIFIED
    ------------------------------