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

Update API models to use envelope format consistently #381

Merged
merged 1 commit into from
Sep 13, 2024

Conversation

alexcreasy
Copy link
Contributor

@alexcreasy alexcreasy commented Sep 13, 2024

Description

Updates the BFF API contract to use envelopes more consistently.

  • All endpoints now use the standard data key for the primary payload
  • POST/PATCH endpoints now accept a request body that matches the envelope format and formats the response body in the same way

How Has This Been Tested?

  • Run through the examples CURLs in the README
  • Verify that the endpoints use the new envelope format { "data": ... } for both request and response bodies

Merge criteria:

  • All the commits have been signed-off (To pass the DCO check)
  • The commits have meaningful messages; the author will squash them after approval or in case of manual merges will ask to merge with squash.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work.
  • Code changes follow the kubeflow contribution guidelines.

If you have UI changes

  • The developer has added tests or explained why testing cannot be added.
  • Included any necessary screenshots or gifs if it was a UI change.
  • Verify that UI/UX changes conform the UX guidelines for Kubeflow.

Signed-off-by: Alex Creasy <alex@creasy.dev>
Copy link
Member

@ederign ederign left a comment

Choose a reason for hiding this comment

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

.

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ederign

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ederign
Copy link
Member

ederign commented Sep 13, 2024

/lgtm

@google-oss-prow google-oss-prow bot added the lgtm label Sep 13, 2024
@google-oss-prow google-oss-prow bot merged commit 95e6b7f into kubeflow:main Sep 13, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants