Repository navigation
Describe every field by what it holds (1.13.75) - #10
Merged
Merged
Conversation
The reference, the topic pages, llms.txt and the changelog now say what each value means and when it is null. The archive tape reads as reconstructed point sequences with no capture timestamps. The point_source_detail value stays as it was, so clients see no change.
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
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.
Rewrites the public docs so they describe the data by what it holds. Bumps the spec to 1.13.75.
What changed in
openapi.yaml,CHANGELOG.md(past entries too) and the prose inscripts/build_reference.py:serveandoutcome, measured statistics and tournament surfaces say what the value means and when it is null.point_source_detailvaluereconstruction from public recordis unchanged, so clients see the same bytes.docs/*.html,docs/llms.txtanddocs/openapi.jsonare regenerated from the spec.No path, operationId, schema name, enum value or field changed. The Scalar comments in
docs/index.htmlare code comments and stay.Checked locally:
npx @redocly/cli@latest lint openapi.yaml: validpython scripts/build_reference.py --check: generated docs are currentsh scripts/truthcheck.sh: OKlint.yml: OK, 48 paths, 49 operations, 66 schemas