[FX-4604] Allow updating External Ticket References #271
Conversation
✅ Deploy Preview for cobalt-public-api ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| "ticketing_system": "jira", | ||
| "external_url": "https://my-project.atlassian.net/browse/TEST-37", | ||
| "external_id": "10214", | ||
| "finding_id": "vl_JTovzf8AW1afCRpKJejse3" |
There was a problem hiding this comment.
I've seen in the api PR that we also return referenceType?
https://github.com/cobalthq/cobalt-api/pull/1349/files#diff-dfe6776effd5e16b02bb720d7d3deb4cd2cdfebb6aad7353ddadd35acdc55accR116
There was a problem hiding this comment.
Yeah we do. It's intentionally omitted from the documentation so that we can remove it later.
Context:
We initially called the functionality "External Finding References" (you'll still find this name in lots of the code).
Before we released (documented) these public API routes, we thought about it again and decided that the name "External Ticket Reference" made a lot more sense, so we released the API routes under that name. As part of that renaming, we also added the ticketing_system property that has the same value as reference_type. reference_type was still exposed because it was used by early workato recipes that were in use by a small handful of customers. The idea is to remove the duplicate (undocumented) API routes with the name /external_finding_references and remove the reference_type property sometime soon-ish.
There was a problem hiding this comment.
After thinking about it some more, I should probably add an explicit note to the docs telling customers not to use the referenceType property because it will be removed. That could be a follow up PR tho
There was a problem hiding this comment.
Thanks for explaining.
No description provided.