Open APIs

Expand all | Collapse all

Service Catalog API's and Open Service Broker Specification

  • 1.  Service Catalog API's and Open Service Broker Specification

    Posted Jun 29, 2021 11:38

    In my company we use a lot the openservicebrokerapi/servicebroker

    GitHub remove preview
    openservicebrokerapi/servicebroker
    Specification OpenAPI doc Release notes Changes in these documents have been accepted by the working group for the next version of the specification, however are still subject to change. Specification OpenAPI doc Roadmap and release planning OSBAPI V3: Call for Input The Getting Started document provides a list of sample Service Brokers, frameworks and libraries that might be useful to developers wanting to implement a Platform or Service Broker.
    View this on GitHub >


    Was there any work done on integrating OSB exposed Services into an Open API Service Catalog.



    ------------------------------
    Florian Kammermann
    Swisscom AG
    ------------------------------


  • 2.  RE: Service Catalog API's and Open Service Broker Specification

    TM Forum Member
    Posted Jun 30, 2021 02:39
    Thanks Florian for raising this.
    I'm not aware of any direction in the Open API team regarding OSB.
    Can you give some business background on what OSB is, what issues does it address, etc.
    Thanks.

    ------------------------------
    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: Service Catalog API's and Open Service Broker Specification

    Posted Jun 30, 2021 04:03

    OSB serves as Service Catalog endpoint, where I can browser Services and their plans and where I can instantiate Services.

    You can see an example here https://petstore.swagger.io/?url=https://raw.githubusercontent.com/openservicebrokerapi/servicebroker/master/openapi.yaml

    For me this looks overlapping with:
    - Service Catalog API
    - Service Inventory Management API
    - Service Ordering Management API
    in https://projects.tmforum.org/wiki/display/API/Open+API+Table

    So my question is if there is a strategy to align these 2 API specs



    ------------------------------
    Florian Kammermann
    Swisscom AG
    ------------------------------



  • 4.  RE: Service Catalog API's and Open Service Broker Specification

    TM Forum Member
    Posted Jun 30, 2021 07:01
    Thanks Florian for the clarification.

    Very interesting. I took a quick look at some of the OSB assets, including their main web page https://www.openservicebrokerapi.org/

    The main question we need to discuss before going further, is what TMF (SID, Open API) concepts map into the OSB service. I'm fairly sure that it is not a network Service in the telco sense, I would think it's closer to Resource or Resource Function. I'd like to hear what others think, especially @Vance Shipley, @Ludovic Robert, and @Johanne Mayer.​

    Watch this space ...

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



  • 5.  RE: Service Catalog API's and Open Service Broker Specification

    Posted Jul 01, 2021 08:34
    Hi Jonathan,
    While we wait for the opinion of the others on the API specs and the comparison, can we have an Architectural principle where the Service Catalog exposure for Order decomp happens only through the Service Catalog API (extension of 633) and not through the OSB,  which is generic and can be used for Product Publish from the catalog.
    The other API in Question 641 is used for Service Order Management after the Product Order Decomposition has happened based on the Service Definitions. And hence not a candidate to aid the decomposition.
    Regards,

    ------------------------------
    Sri Jagadish Baddukonda
    CSGI
    ------------------------------



  • 6.  RE: Service Catalog API's and Open Service Broker Specification

    TM Forum Member
    Posted Jul 07, 2021 18:36
    Thank you Jonathan.  I am no expert on OSB but I would agree with Jonathan's assessment.

    The benefits of TMF APIs are that:
    1) They are all Open Source (anyone have access to the Open API table even non-members)
    2) All of the Open APIs use the same shared information data model which means that referring to the same attribute(s) across the APIs you know that it means the same thing and we try to create the same patterns across APIs.
    3) The target is telecom industry but other industries have also adopted the APIs such as IoT and Smart cities.

    Note that a good number of your colleagues have taken that NaaS Transformation and NaaS API Technical courses at www.naascompass.com using the service level APIs to manage a service end to end - based on TMF909 NaaS API component suite.  See one of your colleagues's note on LinkedIn: https://www.linkedin.com/feed/update/urn:li:activity:68156619549259

    ------------------------------
    Johanne Mayer
    MayerConsult Inc
    ------------------------------