Skip to content

Comments

feat: adding more v1 apis#19

Merged
vigneshrajsb merged 2 commits intoGoodRxOSS:mainfrom
vigneshrajsb:new-apis
Jul 10, 2025
Merged

feat: adding more v1 apis#19
vigneshrajsb merged 2 commits intoGoodRxOSS:mainfrom
vigneshrajsb:new-apis

Conversation

@vigneshrajsb
Copy link
Contributor

What

  • Adds more apis to support v1 version of a console

PS: some api's follow non standard patterns to adopt with existing console ui, will refine as we develop the new console

@vigneshrajsb vigneshrajsb requested a review from a team as a code owner July 10, 2025 13:02
@vigneshrajsb vigneshrajsb requested a review from Copilot July 10, 2025 13:03

This comment was marked as outdated.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@vigneshrajsb vigneshrajsb requested a review from Copilot July 10, 2025 18:59
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds a suite of new v1 API endpoints for the console, introducing list and detail operations for users, repos, pull requests, builds, deploys, deployables, and deploy summaries with filtering and pagination.

  • Implements GET /api/v1/users, /repos, /pull-requests, /builds, /deploys, /deployables, and /deploy-summary endpoints.
  • Supports optional filtering (e.g., by user, repo, status) and pagination across multiple routes.
  • Adds detailed single-resource lookups (/pull-requests/{id}, /builds/{uuid}) and nested resources (builds and deploys under a pull request).

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/pages/api/v1/users/index.ts New endpoint to list distinct GitHub users
src/pages/api/v1/repos/index.ts New endpoint to list distinct repository names
src/pages/api/v1/pull-requests/index.ts New endpoint to list pull requests with filters
src/pages/api/v1/pull-requests/[id]/index.ts Detail endpoint to fetch a pull request by ID
src/pages/api/v1/pull-requests/[id]/builds.ts Nested endpoint to list builds for a pull request
src/pages/api/v1/deploys.ts Endpoint to list deploys by build ID
src/pages/api/v1/deployables.ts Endpoint to list deployables by build ID
src/pages/api/v1/deploy-summary.ts Endpoint to query the deploySummary view
src/pages/api/v1/builds/index.ts Endpoint to list builds with status exclusion
src/pages/api/v1/builds/[uuid]/index.ts Detail endpoint to fetch a build by UUID
Comments suppressed due to low confidence (1)

src/pages/api/v1/deploy-summary.ts:141

  • The field name "deployableID" is inconsistent with the camelCase convention used elsewhere (e.g., pullRequestId). Rename to "deployableId" for consistency.
        "deployableID",

@vigneshrajsb vigneshrajsb merged commit 970f2a9 into GoodRxOSS:main Jul 10, 2025
1 check passed
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