feat(core)!: request body is bare JSON; response body key is 'schema' - #67
Merged
Conversation
BREAKING: a request body is now the raw JSON payload directly under 'request' (no 'example' wrapper), and a response body moves from 'example' to a 'schema' key. Threaded through the on-disk format, edit model, Postman converter, renderer, TUI/GUI, examples, and docs.
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
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.
Summary
Breaking contract-format change. Bodies are written more directly:
request, with noexamplewrapper.exampleto the response'sschemakey.Changes
apic-core:JsonContent.requestis nowOption<Value>(theRequestBodywrapper struct is removed);
Response.examplerenamed toResponse.schema.Threaded through the edit model (
from_contract/to_json), the Postmanconverter, and their tests.
apic readrenderer and the TUI editor read the new shape; thenew-contract seed logic clears the new body keys (
request/schema).example/contracts migrated to the new shape.Old
{ "example": ... }body contracts do not carry over and must be updated(there is no back-compat shim).
Notes
[Unreleased]; the version is left at0.4.0, bumpto
0.5.0(breaking) when you cut the next release.Tests
cargo fmt --all --checkandcargo clippy --workspace --all-targets -- -D warningsare clean;cargo test --workspacepasses (257 tests). Every migratedexample/contract parses under the new format.