Open APIs

 View Only
  • 1.  Rest API definitions - all on one spreadsheet

    Posted Aug 21, 2019 11:49
    Hi Open API Community

    Please can someone advise if it is possible to get a spreadsheet (rather than PDF's or Word) with specific or all REST API specifications?

    Best regards

    Adrian Lord

    Solutions Architecture
    Talk Talk Technology | part of the Talk Talk Group



    ------------------------------
    .
    ------------------------------


  • 2.  RE: Rest API definitions - all on one spreadsheet

    TM Forum Member
    Posted Aug 22, 2019 02:16
    Not clear what your business case is for a spreadsheet. The technical definitions are available as Swagger files, and the word/pdf files contain additional important information (such as use cases, example payloads, principles, etc.). None of this would be easily renderable or readable in a spreadsheet.
    The Open API table gives easy accessed to all the published materials here: https://projects.tmforum.org/wiki/display/API/Open+API+Table
    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 3.  RE: Rest API definitions - all on one spreadsheet

    Posted Aug 28, 2019 04:06
    Edited by Adrian Lord Aug 28, 2019 04:32
    Thanks Jonathan

    I already had found the information you mentioned and it is a very useful (thanks if you were involved in its creation).

    In my case I am comparing 3rd party vendor REST API's (1) with TM Forum API's (2), and downstream provisioning API's (3) that sit in front of other 3rd party (4) API's.

    I am going to be doing a lot of analysis across different specifications, but focused more on the fields and how they line up (or not).  

    Best regards

    Adrian

    ------------------------------
    .
    ------------------------------



  • 4.  RE: Rest API definitions - all on one spreadsheet

    Posted Aug 22, 2019 11:25
    Adrian, we have loaded all TM Forum Open APIs and JSON schemas (and considerable additional Frameworx content) into a model-based repository that allows for virtual any type of reporting you may be interested in. For example, here's a partial list of all the Open APIs:
    Here's a partial list of the mapping of API Definitions to SID Business Entities:
    We can also produce reports that list (based on the imported Swagger and JSON schema files):
    • All paths and methods for each API specification
    • The parameters and return types of each method
    • Which canonical JSON schemas are related to each API definition
    • The properties of all JSON schemas and API definitions
    • Relationships between schemas and between API definitions
    Would be more than happy to discuss this further, if you're interested. You can find an overview of our offering @ https://sparxsystems.us/tmforum/.

    Thanks, Chris ~:|​

    ------------------------------
    Chris Armstrong
    Sparx Services North America
    ------------------------------



  • 5.  RE: Rest API definitions - all on one spreadsheet

    Posted Aug 28, 2019 04:08
    Thanks Chris.  Looks good.  Please drop me a message with the pricing?

    ------------------------------
    .
    ------------------------------



  • 6.  RE: Rest API definitions - all on one spreadsheet

    Posted Sep 03, 2019 10:34
    Adrian, great -- if you could send me an email at chris.armstrong@sparxsystems.us I can get our sales team involved and get you a quote.

    Thanks, Chris ~:|

    ------------------------------
    Chris Armstrong ~:|
    President/Chief Architect
    Sparx Services North America
    chris.armstrong@sparxsystems.us
    ------------------------------