docs: update for enhanced proposal data API - #12
Closed
jean-neiverth wants to merge 2 commits into
Closed
jean-neiverth wants to merge 2 commits into
jean-neiverth wants to merge 2 commits into
Conversation
- Fix stale GitHub URLs: byos-service/crates/byos → byos-service-ts/apps/byos
- Expand GET /proposal/{id} description to reflect full response
- Document ?includeArchived=true on list endpoints
- Note proposals_log fallback for swept proposals in GET by id
- Clarify retention sweep: rows are swept from active store, not deleted;
permanent log ensures a swept proposal is never a 404
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion to bleu/byos-service-ts#92.
Summary
guides/sub-solver-integration.mdand one indesign-document.mdpointed togithub.com/bleu/byos-service/blob/main/crates/byos/openapi.yml(old repo name and path). Updated tobyos-service-ts/blob/main/apps/byos/openapi.yml.GET /proposal/{id}description to reflect the full response (amounts, tokens, interactions, simulation results, timestamps). Added?includeArchived=truenote to both list endpoints.proposals_log, not deleted;GET /proposal/{id}falls back to the log automatically so a swept proposal is never a 404.?includeArchived=trueto query the log directly.