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

[TRIVIAL] Fixed driver OpenAPI /reveal request definition #3164

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mstrug
Copy link
Contributor

@mstrug mstrug commented Dec 13, 2024

Description

OpenAPI driver /reveal request has 3 fields: solutionId, submissionDeadlineLatestBlock, auctionId which is inconsistent with the source code, where /reveal request has only 2 fields: solutionId and auctionId: source.

Changes

/settle and /reveal endpoints have same API definition: Solution, so I've created new API component: SolutionWithDeadline and assigned it to /settle endpoint. From Solution I've removed submissionDeadlineLatestBlock field which now aligns with /reveal endpoint source code.
Renamed driver settle dto module solution.rs to solution_with_deadline.rs and name of the struct Solution to SolutionWithDeadline.

Copy link

Reminder: Please consider backward compatibility when modifying the API specification.
If breaking changes are unavoidable, ensure:

  • You explicitly pointed out breaking changes.
  • You communicate the changes to affected teams.
  • You provide proper versioning and migration mechanisms.

Caused by:

@mstrug mstrug marked this pull request as ready for review December 13, 2024 21:13
@mstrug mstrug requested a review from a team as a code owner December 13, 2024 21:13
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