Open APIs

Back to discussions
Expand all | Collapse all

Resource Order Management API - Swagger / API Spec Difference

  • 1.  Resource Order Management API - Swagger / API Spec Difference

    TM Forum Member
    Posted Apr 29, 2019 11:20
    Throughout the API Spec the attribute "ExternalID" is used, however when implementing the API with the Swagger definition it is named "CorelatioID".

    Please, can anyone advise which is the correct attribute name?

    ------------------------------
    Andrew Lamb
    KCOM Group PLC
    ------------------------------


  • 2.  RE: Resource Order Management API - Swagger / API Spec Difference

    TM Forum Member
    Posted Apr 30, 2019 04:00
    Hi Andrew

    Thanks for your alertness in pointing out this inconsistency.
    We are now working through a process whereby both spec document and swagger file will be generated from the same common sources, thus eliminating such inconsistencies. For R18.5 this was done for some APIs in Service domain, and we are continuing this for R19.0 with additional APIs in Product and Customer domains - the Resource domain is not in the current scope and will hopefully be addressed in a future release.

    I have opened a JIRA issue https://projects.tmforum.org/jira/browse/AP-1294 that references your specific concern, and suggests to align on a single ExternalID across all the APIs that need this concept.

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

    Original Message


  • 3.  RE: Resource Order Management API - Swagger / API Spec Difference

    TM Forum Member
    Posted Apr 30, 2019 08:37
    Hi Jonathan

    Thank you for the very quick response. I look forward to seeing the final release.

    We also noticed that the Swagger definition is missing "resourceorderitem" and it's supporting objects.

    ------------------------------
    Andrew Lamb
    KCOM Group PLC
    ------------------------------

    Original Message


  • 4.  RE: Resource Order Management API - Swagger / API Spec Difference

    Posted Jun 06, 2019 16:15
    Edited by Markus Schmalzried Jun 07, 2019 04:51
      |   view attached
    Hi Jonathan

    I currently have the same problem with tmf652 and the outdated swagger-file. We are considering to use tmf652 in the near future for ordering gigabit lines and therefore I updated the swagger-file to the current pdf specification.
    Perhaps you can take a look at the attached swagger-file (I added an openApi v3 version as well) and replace the current version. I really cannot imagine that anybody can work with the current public version of the swagger-file :)

    Thanks in advance

    ------------------------------
    Markus Schmalzried
    Compax Software Development
    ------------------------------

    Attachment(s)

    zip
    tmf652_swagger.zip   8K 1 version
    Original Message