Skip to content

Adding Docs, Updating Deps, Minor Bigfixes#4

Merged
lreading merged 2 commits into
mainfrom
docs
Mar 1, 2026
Merged

Adding Docs, Updating Deps, Minor Bigfixes#4
lreading merged 2 commits into
mainfrom
docs

Conversation

@lreading

@lreading lreading commented Mar 1, 2026

Copy link
Copy Markdown
Owner
  • Added docs
  • Fixed typo in property, while technically breaking it's really an internal prop, so no major bump at this time
  • Fixed bug in swagger doc generation that was using the old pattern for "success" statuses including the HTTP status in the body.
    • One day, we will give the same treatment to error responses, but that is a breaking change and will require a major version bump
  • Fixed typo in readme, added link to docs
  • Fixed bug where swagger docs gen would error on PATCH requests

The docs are AI generated. I did a bit of UAC by asking another agent to build an API using this framework with only the docs for reference. The generated API was functional and worked as expected on the first try. While not a perfect test, it gives me some confidence that there's enough context for agents and hopefully people to use the docs.

@lreading
lreading merged commit 1db188b into main Mar 1, 2026
1 check passed
@lreading
lreading deleted the docs branch March 1, 2026 19:15
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