Open APIs

Expand all | Collapse all

TMF 673 GeographicAddress: swagger.json - user guide mismatch

  • 1.  TMF 673 GeographicAddress: swagger.json - user guide mismatch

    TM Forum Member
    Posted Oct 19, 2020 07:35

    Hello,
    I had a look at the swagger file for TMF673 from the OpenAPI Table (tmforum-apis/TMF673_GeographicAddress). The user  (PDF) in the same table corresponds to the old version (17.5). But a more up-to-date version is available on the page "Open API Table - Early Adoption (Beta)".

    Now, the new User guide on has a model on page 14 that does not correspond to the swagger file published. There is a model model in the schema called RelatedGeographicLocationRefOrValue that is not present in the swagger file. The attribute geographicLocation refers to model GeographicLocationRefOrValue. The latter does not have the attribute "role" which would be quite useful. What is correct? The User guide or the swagger file?



    ------------------------------
    Martin Goldhahn
    Altibox AS
    ------------------------------


  • 2.  RE: TMF 673 GeographicAddress: swagger.json - user guide mismatch

    TM Forum Member
    Posted Oct 28, 2020 03:19
    We hade to make a couple of adjustments to the GeographicAddress contract in order to support polymorphism and implement the GeoJson spec  (https://tools.ietf.org/html/rfc7946).
    GeographicLocation cannot be the superclass of the GeoJson objects since it uses a different type discriminator. TMF APIs use @type whereas GeoJson uses type. I think that the intention was to do it like this, but the comments in the swagger file were a bit misleading.

    I created a pull request on Github​ with the changes: https://github.com/tmforum-apis/TMF673_GeographicAddress/pull/1

    ------------------------------
    Martin Goldhahn
    Altibox AS
    ------------------------------



  • 3.  RE: TMF 673 GeographicAddress: swagger.json - user guide mismatch

    TM Forum Member
    Posted Oct 28, 2020 03:32
    Hi Martin

    Please note that Open API swagger files are generated from a master schema that is maintained by the Open API team. Pull requests that directly update published swagger files may not be processed correctly, or overridden by future generations.

    I suggest that you reach out to @Alexis de Peufeilhoux who leads the GeoAddress API, and also to @Stephen Harrop who did the work on the GeoLocation API in the area of GeoJson​​, to see how to resolve your issues.

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