docs: Boost version provenance, OpenAPI spec refresh - #519
Merged
Conversation
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  6  8 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
🛡️ The following IaC misconfigurations have been detected
| NAME | FILE | ||
|---|---|---|---|
|
Invalid Format | ...eaviate-openapi.json | View in code |
|
Invalid Format | ...eaviate-openapi.json | View in code |
|
Invalid Format | ...eaviate-openapi.json | View in code |
|
Invalid Format | ...eaviate-openapi.json | View in code |
|
Response Code Missing (v3) | ...eaviate-openapi.json | View in code |
|
Response Code Missing (v3) | ...eaviate-openapi.json | View in code |
|
Template Path With No Corresponding Path Parameter | ...eaviate-openapi.json | View in code |
|
Template Path With No Corresponding Path Parameter | ...eaviate-openapi.json | View in code |
|
Template Path With No Corresponding Path Parameter | ...eaviate-openapi.json | View in code |
|
Template Path With No Corresponding Path Parameter | ...eaviate-openapi.json | View in code |
|
Type Has Invalid Keyword | ...eaviate-openapi.json | View in code |
|
Type Has Invalid Keyword | ...eaviate-openapi.json | View in code |
|
Type Has Invalid Keyword | ...eaviate-openapi.json | View in code |
|
Type Has Invalid Keyword | ...eaviate-openapi.json | View in code |
The note said v1.39. Boost shipped in v1.38.0 and its API surface is unchanged between stable/v1.38 and stable/v1.39.
…tions
Refreshes the committed spec from v1-39/openapi-for-docs: 77 to 81 paths,
adding /aggregate/{collection} and the bm25, hybrid and near-object search
endpoints. info.version is 1.39.0 either way.
The README now leads with the weekly refresh workflow added in #518 and keeps
the manual recipe as a fallback. The old recipe's ${BRANCH} placeholder was a
trap: pasting a branch name into the braces yields a valid parameter expansion,
not a substitution, so the shell silently requests the wrong ref. Because >
truncates before gh runs and gh api writes its error body to stdout, that
replaced the committed spec with a 404 object. The recipe now assigns the
branch on its own line and fetches to a temp file before installing.
g-despot
force-pushed
the
docs/boost-provenance-and-spec-refresh
branch
from
August 20, 2026 11:12
c3e97cd to
7b83e22
Compare
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.
Boost note. It said "Added in
v1.39". Boost shipped in v1.38.0, and the API surface is unchanged betweenstable/v1.38andstable/v1.39(grpc/proto/is byte-identical across the two branches), so the note is now "Added inv1.38". Five pages import this include.OpenAPI spec. Refreshed from
v1-39/openapi-for-docs: 77 to 81 paths, adding/aggregate/{collection}and the bm25, hybrid and near-object search endpoints. Same content the weekly job from #518 would propose, so it will find no diff.README. Leads with that workflow now, manual recipe kept as fallback. The old recipe's
${BRANCH}placeholder was a live trap: pasting a branch name into the braces is a valid parameter expansion, not a substitution, so the shell asks for the wrong ref, and>plusgh apiwriting errors to stdout then overwrites the spec with a 404 object.