Added Candidate Detail endpoint to CandidateAPI #9614
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This endpoint follows the same data structure and query pattern as the index page. API Documentation has also been updated, with this endpoint being added to all previous versions as a non-breaking change.
`#index_query` now takes the `updated_since` argument
Moved the controller query to the serializers. This keeps all the information together in the serializer
dcyoung-dev
force-pushed
the
dy-add-a-candidate-detail-endpoint-to-the-candidate-api
branch
from
4763738
to
6f5a155
Compare
Added documentation
dcyoung-dev
commented
Aug 1, 2024
Comment on lines
-3
to
-28
| class V13 < Base | ||
| def serialize(candidates) | ||
| super.map do |candidate| | ||
| candidate[:attributes][:application_forms].each do |form| | ||
| application_form = ApplicationForm.find(form[:id]) | ||
| form.merge!( | ||
| application_choices: serialize_application_choices(application_form), | ||
| references: serialize_references(application_form), | ||
| qualifications: serialize_qualifications(application_form), | ||
| personal_statement: serialize_personal_statement(application_form), | ||
| ) | ||
| end | ||
|
|
||
| candidate | ||
| end | ||
| end | ||
|
|
||
| def query | ||
| Candidate | ||
| .left_outer_joins(application_forms: { application_choices: %i[provider course interviews], application_references: [], application_qualifications: [] }) | ||
| .includes(application_forms: { application_choices: %i[provider course course_option interviews], application_qualifications: [], application_references: [] }) | ||
| .where('candidates.updated_at > :updated_since OR application_forms.updated_at > :updated_since OR application_choices.updated_at > :updated_since OR "references".updated_at > :updated_since OR application_qualifications.updated_at > :updated_since', updated_since:) | ||
| .where('application_forms.recruitment_cycle_year = ? OR candidates.created_at > ?', RecruitmentCycle.current_year, CycleTimetable.apply_deadline(RecruitmentCycle.previous_year)) | ||
| .order(id: :asc) | ||
| .distinct | ||
| end |
There was a problem hiding this comment.
This was an exact copy of the V12 implementation
| .where(application_forms: { recruitment_cycle_year: RecruitmentCycle.current_year }) | ||
| .or(Candidate.where('candidates.created_at > ? ', CycleTimetable.apply_deadline(RecruitmentCycle.previous_year))) | ||
| .includes(application_forms: :application_choices) | ||
| .find(candidate_id) |
There was a problem hiding this comment.
SELECT "candidates".*
FROM "candidates"
LEFT OUTER JOIN "application_forms" ON "application_forms"."candidate_id" = "candidates"."id"
WHERE ("application_forms"."recruitment_cycle_year" = 2024
OR "candidates".created_at > '2023-09-19 17:00:00')
AND "candidates"."id" = 2452
LIMIT 1
Just posting the query to help my future me.
tomas-stefano
approved these changes
Aug 2, 2024
CatalinVoineag
approved these changes
Aug 2, 2024
dcyoung-dev
deleted the
dy-add-a-candidate-detail-endpoint-to-the-candidate-api
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
The GiT CRM team need a way of accessing data about a specific candidate rather than a list of candidates
Changes proposed in this pull request
Added new
candidates/:candidate_idendpoint to each version of the Candidate APIGuidance to review
Link to Trello card
https://trello.com/c/ts3kEarX
Things to check