Skip to content

Add API description - #503

Closed
nuclearpolygon wants to merge 4 commits into
docmost:mainfrom
nuclearpolygon:nuclearpolygon-API-description
Closed

nuclearpolygon wants to merge 4 commits into
docmost:mainfrom
nuclearpolygon:nuclearpolygon-API-description

Conversation

@nuclearpolygon

@nuclearpolygon nuclearpolygon commented Nov 25, 2024 •

Copy link
Copy Markdown

I've created a postman collection describing most of API endpoints and parameters. It is not perfect but it's a good starting point. I intend to improve the docs on it when I have some spare time.

Summary by CodeRabbit

  • Documentation
    • Added a new API section linking to a Postman collection that covers most Docmost API endpoints.
    • Inserted the API section after the Screenshots area without altering other content structure.
    • Preserved existing license and enterprise licensing notes; no other documentation changes.

@CLAassistant

CLAassistant commented Nov 25, 2024 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@nuclearpolygon

Copy link
Copy Markdown
Author

Hi there! Sorry for not being around for a while. Maybe lets resolve the conflict and merge?

coderabbitai[bot]

This comment was marked as outdated.

nuclearpolygon and others added 2 commits September 24, 2025 12:44
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@mkostechuk

Copy link
Copy Markdown

It would be really helpful to merge this. I was under impression that Docmost doesn't have APIs exposed, and was going to see other products, but luckily I checked Issues and PRs first

@docmost docmost deleted a comment from coderabbitai Bot Feb 14, 2026
@Philipinho

Copy link
Copy Markdown
Member

Thanks for sharing your work.
We just released the official API documentation: https://docmost.com/api-docs

@Philipinho Philipinho closed this Feb 14, 2026
vvzvlad pushed a commit to vvzvlad/gitmost that referenced this pull request Jul 12, 2026
…anon

Issue docmost#503 reported a hardBreak sent via updatePageJson being «silently
cut» — no error, no line break — forcing the agent to split lines into
separate paragraphs.

A faithful repro shows the bug does NOT reproduce against develop:
hardBreak is fully representable in the markdown canon in BOTH directions
and survives the real Yjs write path.

- pm -> md: the serializer (now in @docmost/prosemirror-markdown after the
  docmost#293 STEP 5 consolidation) emits the CommonMark hard break `  \n`, not a
  bare `\n`.
- md -> pm: marked tokenizes `  \n` to `<br>`, which generateJSON parses
  back to a hardBreak node in ONE paragraph (not split, not dropped).
- updatePageJson (PM JSON -> applyDocToFragment = PMNode.fromJSON +
  updateYFragment, the real collab-session write encoder -> read back)
  keeps text + hardBreak + text in one paragraph.

The issue's diagnosis points at packages/mcp/.../markdown-converter.ts as
the serializer, but that file is a 15-line re-export shim since docmost#293 STEP 5
— the diagnosis predates the converter consolidation that already closed
both sides. P1 (semantic round-trip) + P2 (byte-fixpoint) hold, and the
node already has broad property/corpus/golden coverage in the package.

No converter change is warranted (switching the break form to `\`+newline
would churn the whole docmost#351 byte-fixpoint corpus against the established
`  \n` repo convention for zero functional gain). This adds one
integration guard at the MCP canon seam covering all three seams of the
reported updatePageJson path. Mutation-verified: neutering the serializer
arm or the importer `<br>` handling reddens seams 1-2; neutering the real
applyDocToFragment write path reddens seam 3.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
vvzvlad pushed a commit to vvzvlad/gitmost that referenced this pull request Jul 12, 2026
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.

4 participants