edx-enterprise icon indicating copy to clipboard operation
edx-enterprise copied to clipboard

FC-0001: Remove enterprise_catalogs API endpoint

Open ruzniaievdm opened this issue 2 years ago • 6 comments

(5 of 5) for closes https://github.com/openedx/public-engineering/issues/61

Description:

Removed the enterprise_catalogs endpoint

Linked PRs which need merge before merging this:

  • [ ] https://github.com/openedx/edx-enterprise-data/pull/313
  • [x] https://github.com/openedx/enterprise-catalog/pull/468
  • [x] https://github.com/openedx/frontend-app-admin-portal/pull/801
  • [ ] https://github.com/openedx/ecommerce/pull/3742

ruzniaievdm avatar Jun 13 '22 15:06 ruzniaievdm

Thanks for the pull request, @ruzniaievdm! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

openedx-webhooks avatar Jun 13 '22 15:06 openedx-webhooks

I am under the impression that these v1 endpoints are still in use by customers and 3rd party integrations. @mattdrayer may have some more information.

johnnagro avatar Jul 12 '22 17:07 johnnagro

Has a usage analysis been conducted by edX/2U to see which endpoints are actively being utilized, and the customers/integrators notified of the planned deprecation/decommission of the V1 endpoints?

mattdrayer avatar Jul 12 '22 17:07 mattdrayer

@mattdrayer the analysis was carried out during a conversation with 2U, the work plan for removing the endpoint can be seen in the comments to the issue

ruzniaievdm avatar Jul 12 '22 17:07 ruzniaievdm

@mattdrayer the analysis was carried out during a conversation with 2U, the work plan for removing the endpoint can be seen in the comments to the issue

I agree with changing internal service/component references (eg, ecommerce) to utilize the V2 endpoints. However, there are also external customers/consumers of the V1 endpoints and these do not appear to have been considered in the analysis. We cannot disable the V1 endpoints until these third parties have been informed and transitioned.

mattdrayer avatar Jul 12 '22 17:07 mattdrayer

The good news is that the external consumers SHOULD be hitting the V1 endpoints via the AWS API Gateway proxy tier, and so as long as the mapping of the gateway V1 endpoints still returns a valid response -- formatted according to the V1 response schema -- then it does not matter which Open edX component(s) service those requests.

mattdrayer avatar Jul 12 '22 17:07 mattdrayer

@feanil - just checking in on this - do you know if this is still in progress? Does it just need to be reviewed?

mphilbrick211 avatar Jan 27 '23 17:01 mphilbrick211

@mphilbrick211 no, this is not still in progress, unfortunately we were not able to get this work landed and I don't think there is enough appetite for this at the moment so I'm gonna close this for now and it can be revisited in the future.

feanil avatar Jan 27 '23 18:01 feanil

@ruzniaievdm Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

openedx-webhooks avatar Jan 27 '23 18:01 openedx-webhooks