spec: correct a false claim in the README - #38
Merged
Merged
Conversation
spec/README.md said the OpenAPI spec "was not linked from the developer docs". That is wrong. /developers/docs/ has documented it all along under "OpenAPI & clients" — GET /v1/openapi.json, a runnable curl, and guidance to point openapi-generator, Postman or Insomnia at it. The error came from checking the /developers/ hub and not the docs page it links to, then generalising from the one to the other. What the mirror is actually for is unchanged and narrower: the spec existed in no repository, so GitHub code search could not reach it and no API directory could index it from a file. That rationale stands on its own and did not need the overstatement. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NRueWxopDXHoWY2dPvsmLG
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
spec/README.mdclaimed the OpenAPI spec "was not linked from the developer docs". That is wrong.https://greencalculus.com/developers/docs/has documented it all along, under a section called "OpenAPI & clients":…with a runnable
curlexample alongside it.The error came from checking the
/developers/hub, not finding it, and generalising to the docs page the hub links to.What is still true
The rationale for the mirror doesn't depend on the false part, and is narrower than the README claimed: the spec existed in no repository, so GitHub code search could not reach it and no API directory could index it from a file. That is what #36 fixed, and it stands.
No code changes — README prose only. The sync workflow and
spec/openapi.jsonare untouched.🤖 Generated with Claude Code
https://claude.ai/code/session_01NRueWxopDXHoWY2dPvsmLG