Skip to content

DEV-12120: document supported document type schemas - #348

Open
dodeja wants to merge 19 commits into
mainfrom
vorflux/dev-12120-supported-document-types
Open

dodeja wants to merge 19 commits into
mainfrom
vorflux/dev-12120-supported-document-types

Conversation

@dodeja

@dodeja dodeja commented Aug 25, 2026 •

Copy link
Copy Markdown
Member

Documents the proposed account-scoped document type catalog and extraction-field detail endpoint. Depends on backend Terminal49/t49#3311. Do not merge or publish these endpoint claims before the backend contract is available. No live response from the new endpoint has been verified.

Every allowed list item keeps code and label. Catalog-visible items add description and schema metadata; option-only detail requests return 404. Detail payloads retain the sanitizer's structural JSON Schema keys and differ from versioned representation validation schemas. The OpenAPI source, generated SDK types, API reference navigation, and Postman examples are synchronized.

Postman generation keeps schema-based request bodies and disabled optional parameters, then overlays explicitly declared OpenAPI response examples. All regeneration commands use the same wrapper. Regression tests verify option-only items, recursive detail examples, required 401 titles, and a usable webhook edit request body.

Local frozen install, workspace checks/builds/tests, JSON parsing, generated types, five Postman regressions, and three SDK collection-example regressions pass. The strict live MCP preview gate remains blocked by the shared CI credential being rejected by the production backend. One existing SDK live-token test remains skipped. Merge and deployment remain user-controlled.

@mintlify

mintlify Bot commented Aug 25, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
terminal49 🟢 Ready View Preview Oct 14, 2026, 5:04 AM

@linear-code

linear-code Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

DEV-12120

@vercel

vercel Bot commented Aug 25, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
api Ready Ready Preview Oct 14, 2026 6:52am UTC

Request Review

Comment thread docs/openapi.json
Comment thread Terminal49-API.postman_collection.json Outdated
@dodeja
dodeja force-pushed the vorflux/dev-12120-supported-document-types branch from 311fb49 to 4057614 Compare August 25, 2026 16:47
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 13, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-14T06:55:56.739713Z 6b4be4c New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 71e2d65302

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread Terminal49-API.postman_collection.json Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 44bb9d9841

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/openapi.json Outdated
dodeja and others added 6 commits October 13, 2026 21:40
Drops unrelated formatting churn, reuses #/components/schemas/error for the 401/404 responses, removes non-conventional additionalProperties:false, removes a customer name from a public description, and narrows the user component to verified fields.
@dodeja
dodeja force-pushed the vorflux/dev-12120-supported-document-types branch from 44bb9d9 to fed0b47 Compare October 14, 2026 04:45

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7451d23326

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/workflows/generate_postman.yml Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ae10631055

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

generated,
'-p',
'-O',
'folderStrategy=Tags,enableOptionalParameters=false,parametersResolution=Schema',

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve path examples in generated requests

When users import the collection and run the new Get a document type request, this option causes request parameters to be generated from schemas rather than examples, as documented in Postman's parametersResolution option. The final collection therefore stores code as <string> even though the OpenAPI parameter declares packing_list, producing an unusable example URL. Keep schema-based request bodies, but overlay declared request-parameter examples as well and regenerate the collection.

AGENTS.md reference: AGENTS.md:L51-L53

Useful? React with 👍 / 👎.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a3a60a66dd

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread AGENTS.md
- Preview locally: `cd docs && mintlify dev`
- Lint the OpenAPI spec: `spectral lint --ruleset .spectral.mjs docs/openapi.json`
- Regenerate Postman: `openapi2postmanv2 -s docs/openapi.json -o Terminal49-API.postman_collection.json -p -O folderStrategy=Tags,enableOptionalParameters=false`
- Regenerate Postman: `node tools/generate-postman.mjs`

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Update the remaining direct Postman regeneration command

When a documentation contributor follows agent.md:43, the direct openapi2postmanv2 command bypasses the new wrapper's response- and path-example overlays and can overwrite the collection with schema-generated placeholders instead of the declared document-type examples. Update that instruction to use the same wrapper now documented here.

AGENTS.md reference: AGENTS.md:L64-L64

Useful? React with 👍 / 👎.

This branch was successfully deployed

2 active (1 outdated) deployments
Preview — 6b4be4c9 Deployed Oct 14, 2026 by vercel[bot]
staging - docs — 6d16dc7e Deployed Oct 14, 2026 by mintlify[bot]
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