Hi António
You can see that regular Swagger from GitHub
https://github.com/tmforum-apis/TMF620_ProductCatalog is uploaded in March 2018, and "TMF620_Product_Catalog_Management_API_REST_Specification_R17.5.0" created in January 2018. So, Swagger file is more relevant in my view.
Document ProductOfferingPrice contains a
"Price" object, which consist of
taxIncludedAmount,
dutyFreeAmount,
taxRate and
percentage attributes (See the screenshot in attachments).
Swagger file ProductOfferingPrice has a "
tax" collection.
"tax": {
"type": "array",
"items": {
"$ref": "#/definitions/Tax"
}
}
"Tax": {
"type": "object",
"description": "An amount of money levied on the price of a Product by a legislative body.",
"properties": {
"taxAmount": {
"$ref": "#/definitions/Money",
"description": "tax amount"
},
"taxCategory": {
"$ref": "#/definitions/Money",
"description": "A categorization of the tax rate."
},
"taxRate": {
"type": "number",
"format": "float",
"description": "Tax rate"
}
}
And ProductOfferingPrice has no more
"Price" object.
I think you should follow the Swagger file. Also I create Swagger version control in my project to help track changes in Swaggers.
------------------------------
Artyom Valeev
Mobile TeleSystems OJSC
------------------------------
Original Message:
Sent: Jan 15, 2019 10:22
From: António Ribeiro
Subject: Documentation or Swagger File
Dear Forum,
Following the swagger file for "TMF620_Product_Catalog_Management_API_REST_Specification_R17.5.0 " document, <g class="gr_ gr_277 gr-alert gr_spell gr_inline_cards gr_run_anim ContextualSpelling multiReplace" id="277" data-gr-id="277">i've</g> realized the <g class="gr_ gr_85 gr-alert gr_spell gr_inline_cards gr_run_anim ContextualSpelling ins-del multiReplace" id="85" data-gr-id="85">productOffering</g> model included on "GET /productOffering/{id}" interface has a list of taxes inside of productOfferingPrice but this tax list is not represented in the API specification document.
What should <g class="gr_ gr_741 gr-alert gr_tiny gr_spell gr_inline_cards gr_run_anim ContextualSpelling multiReplace" id="741" data-gr-id="741">i</g> <g class="gr_ gr_740 gr-alert gr_spell gr_inline_cards gr_run_anim ContextualSpelling ins-del multiReplace" id="740" data-gr-id="740">Ifollow</g>? The documentation or the swagger file?
I took the documentation and swagger file from this link Open API Table - TM Forum Ecosystem API Portal - TM Forum Confluence
Thanks in advance
Best Regards,
------------------------------
António Ribeiro
Celfocus
------------------------------