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 api.flows settings that are actually for flow groups #63

Merged
merged 5 commits into from
Sep 1, 2020

Conversation

jlowin
Copy link
Member

@jlowin jlowin commented Aug 31, 2020

Summary

Deprecates api.flows functions that actually modify flow group settings

Changes

Routes for enabling/disabling heartbeats, lazarus, and version locking are now available as api.flow_groups.* routes. The old api.flows.* routes remain available as deprecated routes.

This is because the introduction of flow groups has changed how flow settings are managed, but these routes predate the change and are in the wrong module.

Importance

Checklist

This PR:

  • adds new tests (if appropriate)
  • adds a change file in the changes/ directory (if appropriate)

@jlowin jlowin requested a review from cicdw as a code owner August 31, 2020 15:28
@github-actions github-actions bot added the API label Aug 31, 2020
@codecov-commenter
Copy link

codecov-commenter commented Aug 31, 2020

Codecov Report

Merging #63 into master will increase coverage by 0.01%.
The diff coverage is 94.87%.

cicdw
cicdw previously approved these changes Sep 1, 2020
Copy link
Member

@cicdw cicdw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for the changes, but I did have a question



@register_api("flows._update_flow_setting")
async def _update_flow_setting(flow_id: str, key: str, value: any) -> models.FlowGroup:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not important since these are deprecated anyway, but why is this "private"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Historic artifact from an earlier attempt at the server API. I will update the new version in /api/flow_groups (but leave this one for compat)

src/prefect_server/api/flow_groups.py Outdated Show resolved Hide resolved
@cicdw cicdw merged commit d9b4f47 into master Sep 1, 2020
@cicdw cicdw deleted the deprecate-flow-settings branch September 1, 2020 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants