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

Remove /communication-costs/ endpoint #4546

Closed
7 tasks done
jason-upchurch opened this issue Aug 7, 2020 · 2 comments · Fixed by #4705
Closed
7 tasks done

Remove /communication-costs/ endpoint #4546

jason-upchurch opened this issue Aug 7, 2020 · 2 comments · Fixed by #4705
Assignees
Labels
breaking change use when a feature is removed
Milestone

Comments

@jason-upchurch
Copy link
Contributor

jason-upchurch commented Aug 7, 2020

Summary

/communication-costs/ was deprecated and replaced by /communication_costs/ because the pagination was incorrect and the resultset pagination was not as specified.

Technical Guidance

  • The files changed to add the new /communication_costs/ replacement endpoint are at: https://github.com/fecgov/openFEC/pull/4568/files
  • we'll need to refactor for the removal with the idea being:
    • remove the code linked above for the new endpoint
    • replace the paging_schema for the "old" endpoint with OffsetPageSchema
    • rename the /communication-costs/ in rest.py to /communication_costs/
    • in test_costs.py replace CommunicationCostViewOffset with CommunicationCostView and remove import

Action items

  • verify that /communication_costs/ (new endpoint) is working
  • verify that all related cms work is done
  • verify that all related openFEC work is done
  • verify that it has been 30 days since the last email/deprecation notice to api users
    • ONLY AFTER THAT TIME: remove /communication-costs/ (old endpoint)
    • Remove deprecation notice from communication_costs endpoint

Completion criteria

  • /communication-costs/ endpoint is removed
@jason-upchurch jason-upchurch added this to the Sprint 13.4 milestone Aug 7, 2020
@jason-upchurch jason-upchurch added the breaking change use when a feature is removed label Aug 7, 2020
@patphongs patphongs modified the milestones: Sprint 13.4, Sprint 13.5 Aug 31, 2020
@patphongs patphongs modified the milestones: Sprint 13.5, Sprint 13.6 Sep 9, 2020
@patphongs
Copy link
Member

Moving this forward since we still need to make the change in the CMS

@jason-upchurch
Copy link
Contributor Author

jason-upchurch commented Sep 9, 2020

Moving this forward since we still need to make the change in the CMS

@patphongs just in case it's not clear, this issue is not a blocker to the CMS issue which needs to happen _before_the removal. The CMS issue is a blocker to this issue.

sorry, this was my misunderstanding of "forward". It's all fine!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change use when a feature is removed
Projects
None yet
5 participants