Clarify coding-test expectations and align the API contract#7
Open
andywhittle wants to merge 3 commits into
Open
Clarify coding-test expectations and align the API contract#7andywhittle wants to merge 3 commits into
andywhittle wants to merge 3 commits into
Conversation
Rewrite the README to remove ambiguity for candidates completing the test asynchronously: define allocation semantics, make the concurrency requirement and evaluation criteria explicit, enumerate validation and error cases, and add submission guidance. Permit AI tool usage while asking candidates to declare any co-authorship. Fix the Swagger reference: correct the server URL and document the non-2xx responses for each route. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Use the application/vnd.api+json media type for both request bodies, and declare allocation and quantity as integers with minimum constraints (allocation >= 0, quantity >= 1) so the spec matches the validation rules described in the README. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fold the "what we're not expecting" notes and an explicit horizontal- scalability expectation into the Problem definition, and drop the separate "What we're evaluating" and "Concurrency requirement" sections so the brief steers candidates less. Keep "tested code" as a subtle cue in the intro and reframe the SQL dump as an example only. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Why
To make the async coding test self-contained and unambiguous for candidates by clarifying AI usage, submission expectations, validation and error handling, and aligning the API docs with the brief.
What changed
README
Swagger