Skip to content

feat(docu): make it mostly feature complete - #71

Open
jumpy-cat wants to merge 19 commits into
docu/basic-implfrom
docu/mostly-feature-complete
Open

feat(docu): make it mostly feature complete#71
jumpy-cat wants to merge 19 commits into
docu/basic-implfrom
docu/mostly-feature-complete

Conversation

@jumpy-cat

@jumpy-cat jumpy-cat commented Aug 15, 2026

Copy link
Copy Markdown
Member

Description

Added POST route support, more flexibility in the req/res schemas, docstrings, tests. Migrate more routes over and also some small tweaks/fixes.

Type of Change

  • New feature (feat)
  • Bug fix (fix)
  • Refactor / code improvement
  • Dependency / build update
  • Documentation
  • Other (explain)

Related Issues

none

Changes Made

  • Backend (TypeScript):
    • /plan-journey is partially migrated (the res body is set as z.any)
    • /setRemider is migrated
    • how zod schemas that do transformations got handled was changed, which necessitated some changes to the handling of a route
    • global state was reduced with context objects, requiring a refactor of all existing usages
    • documented moved from helper.ts to documented.ts
    • the ordering of declarations in documented was changed to make it easier to find what you need (end user stuff and library internal stuff separated)
    • feature additions and docstrings in documented.ts
    • added documented unit tests
  • Firebase / Shared:
    • the generated specs are uploaded to a server by CI and accessible by url (docs.mb.thething.fyi)

Testing Done

testing from experimental use similar to the lower pr, but it has expanded to use of clients generated with swagger_parser. also the test suite exists now.

Screenshots / Demo (if UI or notification change)

Checklist

  • Commit messages follow Conventional Commits
  • PR title follows [type](scope): short description
  • PR target branch is not main and is our current working update branch (e.g. maizebus2.1)
  • No print() / debugPrint() / console.log() left in production code
  • Secrets / keys not committed

@jumpy-cat jumpy-cat changed the title docu/mostly feature complete feat(docu): make it mostly feature complete Aug 15, 2026
@jumpy-cat
jumpy-cat marked this pull request as ready for review August 15, 2026 23:58
Also reordered the definitions so that the main api is together and
closer to the top + fixed a bug where req & res bodies were mixed up.
Make sure the passed schemas can accept strings as input as that is what
express gives as `path` and `query`. Update module docs.
The previous approach of supporting many status codes and having a 2XX
entry in the generated OpenAPI spec doesn't work well with
swagger_parser. Switch to using only the 200 status code and having an
entry for 200 instead.
Done alongside refactoring plan-journey to use it.
@jumpy-cat
jumpy-cat force-pushed the docu/mostly-feature-complete branch from 7cbfa7e to 27bf0da Compare August 16, 2026 00:04
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