Open APIs

 View Only

  • 1.  TMF API Extension patterns

    Posted Jun 29, 2022 05:50
    Hi All,

    This is  a question from the perspective of the consumer of TMF API that has been extended.

    There was a similar discussion in 8th response in this thread but I could not understand what was agreed on  - Swagger and @schemaLocation | Open APIs (tmforum.org)

    Let's say for example, I'm extending the product like this. This is fine as the developer of the API but for a consumer how will they get a view of these custom objects or extensions? Can I update the original swagger and include the custom type/ derived type as well as the recommended approach like the json below?

    {
  "product": {
    "@baseType": "product",
    "@type": "ProductBroadband",
    "@schemaLocation": "https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/4.0.0/swagger/TMF648-Quote-v4.0.0.swagger.json#/definitions/ProductBroadband",
    "description": "logical",
    "name": "Broadband Access",
    "bandwith": 100,
    "profile": "primary"
  }
}


    ------------------------------
    Ganapathiram Natarajan
    DXC Technology
    ------------------------------


  • 2.  RE: TMF API Extension patterns

    Posted Jun 29, 2022 06:14
    Just to be clear, I can use a Characteristic or productCharacteristic to represent the above and not extend at all, but my question is from the perspective of how a consumer will follow through documentation of extended types.

    ------------------------------
    Ganapathiram Natarajan
    DXC Technology
    ------------------------------

    Original Message


Related Content