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

[609] enabling task: add route for accessing recruitment cycle timetables as html or json #10345

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

elceebee
Copy link
Contributor

@elceebee elceebee commented Feb 6, 2025

Context

This is an enabling task for using the RecruitmentCycleTimetable model in the cycle switcher. In order to 'switch back to production dates', we need to be able to get the production dates. The easiest way to do that is to expose them as json in a public page.

There is also an html rendering for reference

Changes proposed in this pull request

Endpoint for rendering all or one recruitment cycle timetable

Guidance to review

Check the following end points in the review app:
publications/recruitment-cycle-timetables?format=json
publications/recruitment-cycle-timetables/current?format=json
publications/recruitment-cycle-timetables/an-invalid-year-like-2018?format=json
publications/recruitment-cycle-timetables/2023?format=json

And then all again, but without the format=json param to see the html response

Things to check

  • If the code removes any existing feature flags, a data migration has also been added to delete the entry from the database
  • This code does not rely on migrations in the same Pull Request
  • If this code includes a migration adding or changing columns, it also backfills existing records for consistency
  • If this code adds a column to the DB, decide whether it needs to be in analytics yml file or analytics blocklist, if included inform data insights team of the changes
  • If this code adds a column that may include PII, the sanitise.sql script and 0025-protecting-personal-data-in-production-dump.md ADR have been updated
  • API release notes have been updated if necessary
  • If it adds a significant user-facing change, is it documented in the CHANGELOG?
  • Attach the PR to the Trello card

@elceebee elceebee added the deploy_v2 Deploy the review app to AKS label Feb 6, 2025
@elceebee elceebee self-assigned this Feb 6, 2025
@github-actions github-actions bot temporarily deployed to review_aks-10345 February 6, 2025 12:35 Destroyed
@elceebee
Copy link
Contributor Author

elceebee commented Feb 6, 2025

@elceebee elceebee changed the title Add route for accessing recruitment cycle timetables as html or json [609] enabling task: add route for accessing recruitment cycle timetables as html or json Feb 6, 2025
@github-actions github-actions bot temporarily deployed to review_aks-10345 February 6, 2025 12:57 Destroyed
@elceebee elceebee marked this pull request as ready for review February 6, 2025 13:33
@elceebee elceebee requested a review from a team February 6, 2025 13:39
@elceebee elceebee force-pushed the 609-enabling-task-cycle-end-point-for-reverting-to-production branch from 0e43cc3 to 1027375 Compare February 6, 2025 13:46
@github-actions github-actions bot temporarily deployed to review_aks-10345 February 6, 2025 13:51 Destroyed
@elceebee elceebee force-pushed the 609-enabling-task-cycle-end-point-for-reverting-to-production branch from 1027375 to afdcc91 Compare February 6, 2025 13:54
@github-actions github-actions bot temporarily deployed to review_aks-10345 February 6, 2025 14:05 Destroyed
@CatalinVoineag
Copy link
Contributor

Dev tested the endpoints on review, with json and HTML format

@elceebee elceebee force-pushed the 609-enabling-task-cycle-end-point-for-reverting-to-production branch from afdcc91 to bc1d37f Compare February 6, 2025 14:43
@github-actions github-actions bot temporarily deployed to review_aks-10345 February 6, 2025 14:49 Destroyed
@elceebee elceebee force-pushed the 609-enabling-task-cycle-end-point-for-reverting-to-production branch from bc1d37f to 97c5f8a Compare February 6, 2025 15:48
@elceebee elceebee requested a review from dcyoung-dev February 6, 2025 15:51
@github-actions github-actions bot temporarily deployed to review_aks-10345 February 6, 2025 15:53 Destroyed
@elceebee elceebee force-pushed the 609-enabling-task-cycle-end-point-for-reverting-to-production branch 2 times, most recently from 5fc6de1 to 9de20e7 Compare February 6, 2025 16:01
@github-actions github-actions bot temporarily deployed to review_aks-10345 February 6, 2025 16:10 Destroyed
@elceebee elceebee force-pushed the 609-enabling-task-cycle-end-point-for-reverting-to-production branch from 9de20e7 to 563938b Compare February 7, 2025 16:29
@github-actions github-actions bot temporarily deployed to review_aks-10345 February 7, 2025 16:35 Destroyed
@elceebee elceebee force-pushed the 609-enabling-task-cycle-end-point-for-reverting-to-production branch from 563938b to 1fd18e9 Compare February 10, 2025 11:20
@github-actions github-actions bot temporarily deployed to review_aks-10345 February 10, 2025 11:25 Destroyed
Copy link
Collaborator

@dcyoung-dev dcyoung-dev left a comment

Choose a reason for hiding this comment

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

Nice work! These endpoints will be great for the Reference Data maintainers to auto-generate the cycle timetables 👌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy_v2 Deploy the review app to AKS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants