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

💥 Normalize api endpoints to kebab case #4914

Merged

Conversation

sergei-maertens
Copy link
Member

Part of #3283

Changes

  • API endpoints are now consistently using dashes rather than underscores (except for the action prefix for non-REST endpoints)
  • Removed obsolete redirect - the SDK has been updated

Checklist

Check off the items that are completed or not relevant.

  • Impact on features

    • Checked copying a form
    • Checked import/export of a form
    • Config checks in the configuration overview admin page
    • Problem detection in the admin email digest is handled
  • Release management

    • I have labelled the PR as "needs-backport" accordingly
  • I have updated the translations assets (you do NOT need to provide translations)

    • Ran ./bin/makemessages_js.sh
    • Ran ./bin/compilemessages_js.sh
  • Dockerfile/scripts

    • Updated the Dockerfile with the necessary scripts from the ./bin folder
  • Commit hygiene

    • Commit messages refer to the relevant Github issue
    • Commit messages explain the "why" of change, not the how

Some older endpoints used underscores, but the majority of endpoints
use kebab-case to separate words, so now everything is normalized.

This requires a PR to the SDK to handle the changes, as no redirects
are being set up. All of these endpoints are private API.
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.57%. Comparing base (3a70208) to head (3506583).
Report is 21 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4914   +/-   ##
=======================================
  Coverage   96.57%   96.57%           
=======================================
  Files         757      757           
  Lines       25750    25750           
  Branches     3383     3383           
=======================================
  Hits        24869    24869           
  Misses        616      616           
  Partials      265      265           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sergei-maertens sergei-maertens changed the title Normalize api endpoints to kebab case 💥 Normalize api endpoints to kebab case Dec 13, 2024
Copy link
Contributor

@robinmolen robinmolen left a comment

Choose a reason for hiding this comment

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

Looks good 👍

@sergei-maertens sergei-maertens merged commit 4f57eb8 into master Dec 17, 2024
34 checks passed
@sergei-maertens sergei-maertens deleted the cleanup/3283-normalize-api-endpoints-to-kebab-case branch December 17, 2024 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants