Skip to content

spec: correct a false claim in the README #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeremiahsay merged 1 commit into from
Sep 19, 2026
Merged

spec: correct a false claim in the README #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions spec/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ The authority is the gateway, which serves it at
<https://api.greencalculus.com/openapi.json>. That URL is what
`postman/generate.py` reads, and it is the one to integrate against.

But a live URL is not a discoverable one. It was not linked from the developer
docs, it is not in any repository, and nothing that crawls GitHub could find it.
A spec that tools cannot discover is, for most purposes, a spec that does not
exist — the same point `src/openapi.ts` makes upstream about a capability absent
from the machine-readable contract.
But a documented URL is not the same as a discoverable file. The API reference
at <https://greencalculus.com/developers/docs/> has documented this spec all
along, under "OpenAPI & clients", with a runnable `curl` and instructions to
point openapi-generator, Postman or Insomnia at it. What was missing is narrower
and purely mechanical: the spec existed in no repository, so nothing that crawls
or code-searches GitHub could reach it, and no API directory could index it from
a file.

So this is a published mirror, for GitHub code search, API directories, codegen
and coding assistants.
Expand Down
Loading