Open APIs

 View Only

  • 1.  Updated of json files- for resource order and catalogue management?

    TM Forum Member
    Posted Nov 19, 2019 03:10
    Dear All,

    I downloaded the spec and the files for both resource order management and resource catalogue management from the https://projects.tmforum.org/wiki/display/API/Open+API+Table
    Apparently the json files shows some errors in the swagger editor and as a result, as we use the enterprise architect (EA), there are an error when importing 
    When I tried to import those files into the EA, i don't see ressource package, where normally the GET, PATCH etc can be seen in the model (but in swagger they do exist). The PlugInns itself seems to be fine as I successfully imported Service Order Management, where the resources (GET,PATCh,DELETE etc) were included.
    Is there any updated version of the json in the git hub you guys can pls upload? Many thanks in advance!
    Cheers
    Erlina

    ------------------------------
    Erlina Hennies
    Deutsche Telekom AG
    ------------------------------


  • 2.  RE: Updated of json files- for resource order and catalogue management?

    TM Forum Member
    Posted Nov 19, 2019 04:44
    Hi Erlina
    The Open API team is working on updating the Resource family APIs, including catalog and order. Hopefully the assets (including specs and swagger files) will be published sometime in the relatively near future, but no promises for timescale.
    Can you be more specific as to the errors you encountered in the current swagger files?
    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.
    ------------------------------

    Original Message


  • 3.  RE: Updated of json files- for resource order and catalogue management?

    TM Forum Member
    Posted Nov 27, 2019 03:57
    ​Hi Jonathan,

    I'd like to summarize our email conversation in this thread and eventually the result. As TMF is currently working on a mobile porting API, we thought the Ressource family APIs are the most suitable APIs (rather than Service Order) for our purpose (Mobile Porting Number for Im- and Export).
    We would need only few attributes and objects for purpose, at this stage.  I have contacted Yaki who is working on this (on AmDoc-Side) and we will keep in touch.

    Anyhow, we have debugged the json from ResourceOrder and currently there are two lines of information are missing in the JSON as follows:
    …
    ...
    tags:
    - name: resourceOrder
    ..
    ..

    These shall be added between produces: and paths: see example below:
    consumes:
      - application/json
    produces:
      - application/json
    tags:
    - name: resourceOrder
    paths:
      /resourceOrder:

    As the result: following packages are imported in our UML Model:  <<Resource-Tag>> resourceOrder
    <<POST>> createResourceOrder
    <<DELETE>> deleteResourceOrder
    <<GET>> listResourceOrder
    <<PATCH>> patchResourceOrder
    <<GET>> retrieveResourceOrder

    AS for now we can continue working.

    I haven't tried adding these in the resource inventory and catalogue (to add those syntaxes) though, but surely a try.

    Anyway, we still get some error while importing the JSON (that ambiguous resource are missing). This confirms your statement that the Resource family APIs are not completed yet. Thank you for your help for now.

    Regards
    Erlina


    ------------------------------
    Erlina Hennies
    Deutsche Telekom AG
    ------------------------------

    Original Message


  • 4.  RE: Updated of json files- for resource order and catalogue management?

    TM Forum Member
    Posted Nov 27, 2019 05:54
    I'm glad to hear that you are managing to work for the time being. Since you are working with Resource Order, I'm looping in @Steve Harrop, who is now working on refreshing that API​. As far as I am aware, however, we don't manually specify tags in the swagger file, they are added automatically by the tooling.

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

    Original Message


  • 5.  RE: Updated of json files- for resource order and catalogue management?

    TM Forum Member
    Posted Nov 27, 2019 06:17
    Edited by Steve Harrop Nov 27, 2019 06:17
    Hi Jonathan and @Erlina Hennies,

    As @Jonathan Goldberg    ​​ says - I am currently rewriting the TMF ResourceOrder API this week and I am working with Jonathan and @Thomas Braun who are recasting the associated ResourceCatalog and ResourceInventory APIs alongside - so we are all in-sync. These rewrites also produce a step-change in the ​consistency within and between the APIs, as well as their Documentation, Conformance Test Kits (CTKs) and Reference Implementations (RIs) -- all now derived.

    PS: You will have noticed that the last published ResourceOrder class diagram does not match-up with its associated last-published swagger file - this will be fixed, and as Jonathan says the tags will be there in the next version.

    ------------------------------
    Stephen Harrop
    Principal Enterprise Architect
    Vodafone Group
    ------------------------------

    Original Message


  • 6.  RE: Updated of json files- for resource order and catalogue management?

    TM Forum Member
    Posted Nov 29, 2019 06:53
    Dear all,

    Thanks! In the meantime, we still get an error in the swagger file regarding the path of the id.
    We are looking forward to have the fix soon.

    Regards

    Erlina

    ------------------------------
    Erlina Hennies
    Deutsche Telekom AG
    ------------------------------

    Original Message