Open APIs

Hi  there,

Looking for your input  related to the type of href used in resource models.
 uri and string are being used interchangeably  for various resources. What's the recommended usage?

Some examples from resource model:

​​​

------------------------------
Uma Lakshman
Telstra Corporation
------------------------------

Hi Uma
href is of json type string, with a format modification uri, as you can see from the central definition here:
"href": {
"type": "string",
"format": "uri",
"description": "Hyperlink reference"
},
For various reasons relating to tooling issues, timing of swagger and user guide generation, and more, it's possible that individual APIs may have missed the uri format.

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

Thanks @Jonathan Goldberg.
Should we create a jira card to track this as we can see this misalignment in many API documentations ?

​

------------------------------
Uma Lakshman
Telstra Corporation
------------------------------

Original Message:
Sent: Jun 09, 2021 08:11
From: Jonathan Goldberg
Subject: type of href

Hi Uma
href is of json type string, with a format modification uri, as you can see from the central definition here:
"href": {
"type": "string",
"format": "uri",
"description": "Hyperlink reference"
},
For various reasons relating to tooling issues, timing of swagger and user guide generation, and more, it's possible that individual APIs may have missed the uri format.

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

Hi Uma
I'm not sure that it's worth the trouble. I doubt that there is much impetus to republish v4 APIs just for this. v5 will (hopefully) happen very soon and we can expect such discrepancies to have been fixed by then.
But that's my own view, as I state in my signature I don't represent the TM Forum.

------------------------------
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:
Sent: Jun 11, 2021 00:12
From: Uma Lakshman
Subject: type of href

Thanks @Jonathan Goldberg.
Should we create a jira card to track this as we can see this misalignment in many API documentations ?

​

------------------------------
Uma Lakshman
Telstra Corporation
------------------------------


Original Message:
Sent: Jun 09, 2021 08:11
From: Jonathan Goldberg
Subject: type of href

Hi Uma
href is of json type string, with a format modification uri, as you can see from the central definition here:
"href": {
"type": "string",
"format": "uri",
"description": "Hyperlink reference"
},
For various reasons relating to tooling issues, timing of swagger and user guide generation, and more, it's possible that individual APIs may have missed the uri format.

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.