Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate and remove /api/devfile method #13867

Closed
skabashnyuk opened this issue Jul 16, 2019 · 6 comments · Fixed by #13992
Closed

Deprecate and remove /api/devfile method #13867

skabashnyuk opened this issue Jul 16, 2019 · 6 comments · Fixed by #13992
Assignees
Labels
kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system. status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. status/in-progress This issue has been taken by an engineer and is under active development.
Milestone

Comments

@skabashnyuk
Copy link
Contributor

skabashnyuk commented Jul 16, 2019

Is your task related to a problem? Please describe.

This is an outdated method to create a workspace. The correct one is /api/workspace/devfile
And some users might be confused when using it. Like this onehttps://github.com//issues/13860

Describe the solution you'd like

We should.

  • Deprecate it with some good message first.
  • Remove DevfileService completely

Describe alternatives you've considered

none

Additional context

none

@skabashnyuk skabashnyuk added kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system. team/platform and removed kind/task Internal things, technical debt, and to-do tasks to be performed. labels Jul 16, 2019
@skabashnyuk skabashnyuk added this to the 7.0.0 milestone Jul 16, 2019
@skabashnyuk
Copy link
Contributor Author

CC @rhopp @l0rd

@skabashnyuk skabashnyuk added the kind/task Internal things, technical debt, and to-do tasks to be performed. label Jul 16, 2019
@l0rd
Copy link
Contributor

l0rd commented Jul 16, 2019

I am ok to add to 7.0.0 but please wait tomorrow approval of others issue "curators" before merging the related PR.

@slemeur
Copy link
Contributor

slemeur commented Jul 16, 2019

Can the issue say which will be the replacement API?

@l0rd l0rd mentioned this issue Jul 16, 2019
85 tasks
@skabashnyuk
Copy link
Contributor Author

@l0rd @slemeur ok

@nickboldt
Copy link
Contributor

+100 to remove old API /api/devfile and replace with /api/workspace/devfile in 7.0.0.GA release.

But if this was introduced NEW in 7.0, you should be able to just remove it entirely without the need to deprecate, since anything 7.0.0.[pre-GA] is not supported and subject to change, even in a for-real RC.

If it isn't removed before 7.0.0.GA, THEN you would have to deprecate it in 7.1 and remove it in some future release (7.4?) so people have time to adapt to the new API path.

@skabashnyuk
Copy link
Contributor Author

I thought that this pr would be part of RC next week and in a next GA we will remove this API at all.

@l0rd l0rd added severity/P2 Has a minor but important impact to the usage or development of the system. status/in-progress This issue has been taken by an engineer and is under active development. and removed severity/P1 Has a major impact to usage or development of the system. labels Jul 23, 2019
@skabashnyuk skabashnyuk added the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label Jul 24, 2019
@skabashnyuk skabashnyuk self-assigned this Jul 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P2 Has a minor but important impact to the usage or development of the system. status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. status/in-progress This issue has been taken by an engineer and is under active development.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants