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

chore: update openapi.yml for solver-driver communication #2182

Closed
1 task
fhenneke opened this issue Dec 18, 2023 · 1 comment · Fixed by #2192
Closed
1 task

chore: update openapi.yml for solver-driver communication #2182

fhenneke opened this issue Dec 18, 2023 · 1 comment · Fixed by #2192
Assignees
Labels
E:3.1 Driver Colocation See https://github.com/cowprotocol/pm/issues/14 for details

Comments

@fhenneke
Copy link

Background

Solvers are supposed to change their solver engines to receive auctions and return solutions conforming to a new API.
However, the specification in openapi.yml seems to be out of sync with what is actually used in the communication between driver and solver here and here.

Acceptance criteria

  • Update openapi.yml to be consistent with the rust code
@fleupold
Copy link
Contributor

I'll look into updating the yaml files

@fleupold fleupold added the E:3.1 Driver Colocation See https://github.com/cowprotocol/pm/issues/14 for details label Dec 19, 2023
This was referenced Dec 19, 2023
fleupold added a commit that referenced this issue Dec 21, 2023
# Description
The driver API is not up to date.

# Changes

- [x] Add reveal endpoint
- [x] Update all existing fields
- [x] Add feePolicy fields
- [x] Flatten and tag feePolicy enum in-line with remaining enums (e.g.
Liquidity)

## How to test
Pasted the text in to see it render correctly

## Related Issues

Part of #2182
fleupold added a commit that referenced this issue Dec 21, 2023
# Description
Docs were slightly out of date

# Changes

- [x] Updates all fields and structs on the existing endpoint
- [x] Remove pre-interactions for jit orders (for some reason we didn't
populate post interactions and since those orders aren't really used in
practice anyways, it seemed simpler to remove pre interactions instead
of adding post interactions).
- [x] Flatten notification type to make it consistent with the way we
encode enums elsewhere in the new API (cf. `Liquidity`)
- [x] Flatten Score enum to make it consistent
- [x] Document notify endpoint

## How to test
Past into https://editor.swagger.io/ and compare line by line with the
rust structs

## Related Issues

Fixes #2182
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E:3.1 Driver Colocation See https://github.com/cowprotocol/pm/issues/14 for details
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants