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

[DRAFT] Implement ResultsAPI #95

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

[DRAFT] Implement ResultsAPI #95

wants to merge 12 commits into from

Conversation

IsabelLaurenceau
Copy link
Contributor

We prefer smaller PRs that merge more often.

Haiku-length summary

Create a new service
so results API
has a place to live

Additional details

Draft PR for Create API cmd/app which is a subtask of implement results API #33

The purpose of this PR is to stand up the resultsAPI service. This creates an endpoint that returns dummy JSON data in the format expected and handles the required input parameters.

Still to do:
-- documentation updates to be added (this PR)
-- test coverage (to be added in implement results API #33 )
-- retrieve actual data

PR Checklist: Submitter

  • Link to an issue if possible. If there’s no issue, describe what your branch does. Even if there is an issue, a brief description in the PR is still useful.
  • List any special steps reviewers have to follow to test the PR. For example, adding a local environment variable, creating a local test file, etc.
    N/A
  • For extra credit, submit a screen recording like this one.
  • Make sure you’ve merged main into your branch shortly before creating the PR. (You should also be merging main into your branch regularly during development.)
  • Make sure that whatever feature you’re adding has tests that cover the feature. This includes test coverage to make sure that the previous workflow still works, if applicable.
  • Make sure the E2E tests pass.
  • Do manual testing locally.
    • If that’s not applicable for some reason, check this box.
  • Once a PR is merged, keep an eye on it until it’s deployed to dev, and do enough testing on dev to verify that it deployed successfully, the feature works as expected, and the happy path for the broad feature area still works.

PR Checklist: Reviewer

  • Pull the branch to your local environment and run make macup ; make e2e" (FIXME)
  • Manually test out the changes locally
    • Check this box if not applicable in this case.
  • Check that the PR has appropriate tests.

The larger the PR, the stricter we should be about these points.

@IsabelLaurenceau IsabelLaurenceau marked this pull request as draft January 23, 2025 21:14
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.

1 participant