search

sailpoint-oss / developer.sailpoint.com

The codebase that makes up developer.sailpoint.com, including developer documentation. This codebase is open source and welcomes contributions.
https://developer.sailpoint.com
MIT License
32 stars 85 forks source link

Requesting changes to 'Update Account' (update-account) Beta API #293

Closed jason545454 closed 1 year ago

jason545454 commented 1 year ago

Firstly, how is the PATCH /beta/accounts/:id different from the PATCH /v3/accounts/:id ?

I tried both (in postman) and they seem to function the same

/beta only allowed the update of the the following fields ONLY (same as v3):

To Reproduce Steps to reproduce the behavior:

  1. Run PATCH /v3/accounts/:id
  2. Run PATCH /beta/accounts/:id

Additional context If /beta only allows updating too of those 2 attributes, please update beta page to say so too.

Ideal Outcome /beta/accounts/:id would allow updating of all attributes, not just those 2.

Thank you

colin-mckibben-sp commented 1 year ago

Beta and v3 endpoints will usually be the same. This is because beta endpoints are promoted to v3 once the beta is deemed ready for long term support. The beta endpoint remains so we don't break any integrations that rely on it.

As for your request to allow updating more attributes using PATCH, that is feedback we have received here: https://developer.sailpoint.com/discuss/t/post-api-account-setaccountdata/8808/4.

Given that the v3 version is preferred over beta, we won't be making any update to the beta spec.

jason545454 commented 1 year ago

Thanks @colin-mckibben-sp

Would it make sense then on the /beta page to make a banner/note that it has been promoted to /v3, and therefore to refer to /v3 page for accurate documentation?