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

Jump to bottom

544 Deprecation notice for API versions 1.0 to 2.0 #554

Merged
merged 11 commits into from Dec 16, 2022
Merged

544 Deprecation notice for API versions 1.0 to 2.0 #554

merged 11 commits into from Dec 16, 2022

Conversation

Flix6x
Copy link
Contributor

@Flix6x Flix6x commented Dec 13, 2022 •
edited

  • Deprecation notices in response headers
  • Sunset notices in response headers
  • Documentation regarding monitoring of deprecation and sunsetting
  • Log warnings
  • API blueprints done
  • API FlaskViews done [we only started using FlaskViews in v3]

@Flix6x
Add and test deprecation warnings to API users
45b8b55 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
Provide deprecation information via headers instead of via JSON messa…
ebe63b9 
…ge, which is the approach recommended by the Internet Engineering Task Force (IETF)

Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
API changelog entries
d9187b9 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x added documentation Improvements or additions to documentation API deprecation Still Needs Changelog Entry labels Dec 13, 2022
@Flix6x Flix6x added this to the 0.12.0 milestone Dec 13, 2022
@Flix6x Flix6x self-assigned this Dec 13, 2022
@Flix6x Flix6x added this to In progress in Deprecate old database models via automation Dec 13, 2022
@Flix6x Flix6x linked an issue Dec 13, 2022 that may be closed by this pull request
Deprecation notice for API versions 1.0 to 2.0 #544
Closed
2 tasks
@Flix6x
black
056f4ab 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
Log warning
97a9aa0 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
Clean up
cd7dda5 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
Add release notice for FlexMeasures hosts
7c6f3f4 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@coveralls
Copy link
Collaborator

coveralls commented Dec 13, 2022 •
edited

Pull Request Test Coverage Report for Build 3714070216

  • 49 of 50 (98.0%) changed or added relevant lines in 8 files are covered.
  • 2 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.09%) to 65.022%
Changes Missing Coverage Covered Lines Changed/Added Lines %
flexmeasures/api/common/utils/deprecation_utils.py 29 30 96.67%
Files with Coverage Reduction New Missed Lines %
flexmeasures/init.py 2 81.82%
Totals Coverage Status
Change from base Build 3679180325: 0.09%
Covered Lines: 6687
Relevant Lines: 9642
💛 - Coveralls

@Flix6x
Changelog entry
31e6dd4 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x marked this pull request as ready for review December 13, 2022 14:41
@Flix6x
Fix header links
799c518 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x
Also test asset API v2
2401064 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x requested a review from nhoening December 13, 2022 15:00
nhoening
nhoening approved these changes Dec 15, 2022
View reviewed changes
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

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

Looks great!

I believe there are some tests in "fresh" modules for 1, 1.1 and 1.3 which have no tests (e.g. test_api_v1_3_fresh_db.py). Not sure if you want to add them, as well. We are now testing every version...

Deprecate old database models automation moved this from In progress to Reviewer approved Dec 15, 2022
@Flix6x
Add missing deprecation checks
701f799 
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x merged commit c93f60d into main Dec 16, 2022
Deprecate old database models automation moved this from Reviewer approved to Done Dec 16, 2022
@Flix6x Flix6x deleted the 544-warn-for-deprecation-notice-for-api-versions-10-to-20 branch December 16, 2022 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nhoening nhoening nhoening approved these changes

Assignees

@Flix6x Flix6x

Labels
API deprecation documentation Improvements or additions to documentation
Projects
Deprecate old database models
  
Done
Milestone
0.12.0
Development

Successfully merging this pull request may close these issues.

Deprecation notice for API versions 1.0 to 2.0
3 participants
@Flix6x @coveralls @nhoening