Skip to content

docs: publish the Serverpod Cloud API URL and update Serverpod version references - #121

Merged
moises-cisneros merged 3 commits into
mainfrom
docs/31-deploy-urls
Oct 8, 2026
Merged

moises-cisneros merged 3 commits into
mainfrom
docs/31-deploy-urls

Conversation

@TOMOKI977

Copy link
Copy Markdown
Contributor

Refs #31

Docs-only follow-up to the Serverpod Cloud deploy (#117). It covers the "Both URLs are in the README" criterion. #31 stays open for the end-to-end GIF and the teammate redeploy.

Changes

File Change
README.md Deploy table links the real API URL (puls3-hub-on-stellar.api.serverpod.space). The health-check example sends -d '{}' (Cloud answers 411 without a body) and shows a sample response.
puls3_server/README.md The CORS preflight note says Serverpod 4.0.4 instead of 3.4.13.
puls3_server/lib/src/cors/allowed_origins.dart Same version fix in the doc comment. There is no code change.
docs/infra/secrets.md The prerequisite is Serverpod CLI 4.0.4.

docs/operations/serverpod-4-migration.md still mentions 3.4.13 on purpose: that line is the rollback step.

Verification

  • curl -s -X POST -d '{}' https://puls3-hub-on-stellar.api.serverpod.space/health/check returns {"__className__":"BackendHealth","version":"1.0.0+4df3ba4"}.
  • An OPTIONS preflight against production on 4.0.4 still returns Access-Control-Allow-Origin: *, so the CORS note stays accurate.

…n references

Refs #31. The root README now links the deployed API instead of a placeholder, and the health check example sends a body (Serverpod Cloud answers 411 without one). Serverpod 3.4.13 references in the server README, the CORS middleware doc and the secrets guide now say 4.0.4; preflight behavior was re-verified against production.
@TOMOKI977 TOMOKI977 added this to the Serverpod (Oct 14) milestone Oct 8, 2026
@TOMOKI977 TOMOKI977 added area: docs Vision, pitch, README, ADRs type: docs Documentation deliverable labels Oct 8, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Deploying puls3 with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2604ebf
Status:⚡️  Build in progress...

View logs

@TOMOKI977

Copy link
Copy Markdown
Contributor Author

@moises-cisneros @fercodes @Pericena @XxHugheadxX small docs PR waiting on a review (the API URL in the root README, Serverpod 4.0.4 references). It is part of #31. Could someone take a look today?

@XxHugheadxX XxHugheadxX left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Checked against production:

  • POST -d '{}' /health/check returns {"__className__":"BackendHealth","version":"1.0.0+4df3ba4"}.
  • A preflight with Origin: https://evil.example returns 200 with Access-Control-Allow-Origin: *, so the 4.0.4 note is accurate. I also confirmed this in the serverpod-4.0.4 source: _headers is injected before addMiddleware and returns early on OPTIONS.
  • A POST from that origin gets 403, and one from https://puls3-4lw.pages.dev gets 200.
  • Outside the openspec archive, the remaining 3.4.13 references on main are the ones this PR fixes. The migration doc is the intended exception.

@moises-cisneros
moises-cisneros merged commit fc1e7af into main Oct 8, 2026
9 of 10 checks passed
@moises-cisneros
moises-cisneros deleted the docs/31-deploy-urls branch October 8, 2026 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Vision, pitch, README, ADRs type: docs Documentation deliverable

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants