Skip to content

chore(spec): refresh vendored Roblox OpenAPI document and scope catalog - #39

Open
rbx-forge-spec-bot[bot] wants to merge 1 commit into
mainfrom
chore/update-openapi
Open

chore(spec): refresh vendored Roblox OpenAPI document and scope catalog#39
rbx-forge-spec-bot[bot] wants to merge 1 commit into
mainfrom
chore/update-openapi

Conversation

@rbx-forge-spec-bot

@rbx-forge-spec-bot rbx-forge-spec-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown

Vendored Roblox OpenAPI document refreshed

Upstream: Roblox/creator-docs@bc72ab94f87487eb2f8b6a5d0842708466e30766 (2026-08-28)
Document: content/en-us/reference/cloud/openapi.json
Scope catalog: regenerated from the same bytes.

The drift check passed: every endpoint this workspace calls is still present in the refreshed document.

A human has to review this

This PR is an alarm, not a fix. Roblox changed the document; whether that
breaks us is a judgement call this automation cannot make. Review the diff for changes this check cannot see (renamed response fields, new required parameters, changed enum values) then merge.

Note that the drift check only verifies that endpoint paths still exist.
It cannot see a renamed or retyped response field, which is the other way a
Roblox change turns into Failed to parse response for users. The diff on
spec/openapi.json is the place to look for those.

Drift check output
�[1m�[92m    Updating�[0m crates.io index
�[1m�[92m Downloading�[0m crates ...
�[1m�[92m  Downloaded�[0m zmij v1.0.21
�[1m�[92m  Downloaded�[0m itoa v1.0.18
�[1m�[92m  Downloaded�[0m serde_core v1.0.228
�[1m�[92m  Downloaded�[0m memchr v2.8.0
�[1m�[92m  Downloaded�[0m serde_json v1.0.149
�[1m�[92m   Compiling�[0m serde_core v1.0.228
�[1m�[92m   Compiling�[0m zmij v1.0.21
�[1m�[92m   Compiling�[0m serde_json v1.0.149
�[1m�[92m   Compiling�[0m memchr v2.8.0
�[1m�[92m   Compiling�[0m itoa v1.0.18
�[1m�[92m   Compiling�[0m rbx-spec-drift v0.5.0 (/home/runner/work/rbx-cli/rbx-cli/crates/rbx-spec-drift)
�[1m�[92m    Finished�[0m `test` profile [unoptimized + debuginfo] target(s) in 4.56s
�[1m�[92m     Running�[0m tests/openapi_drift.rs (target/debug/deps/openapi_drift-e95e2702ed80ba52)

running 10 tests
test a_mention_in_a_doc_comment_is_not_an_attribute ... ok
test a_cfg_test_item_hides_itself_and_nothing_after_it ... ok
test a_trailing_test_module_is_still_removed_whole ... ok
test engine_avatar_settings_is_still_an_opaque_string ... ok
6 configs endpoint(s) checked against Roblox/creator-docs @ bc72ab94f87487eb2f8b6a5d0842708466e30766 (2026-08-28).
test every_configs_endpoint_is_documented_in_the_spec ... ok
test the_item_scanner_is_not_fooled_by_braces_in_strings_or_lifetimes ... ok
test the_manifest_scan_sees_dependencies_and_ignores_dev_dependencies ... ok
test every_request_body_matches_the_schema_the_spec_documents ... ok
20 crate(s) with an HTTP dependency, 19 contributing endpoints, 1 exempt.
test every_crate_that_calls_roblox_contributes_an_endpoint ... ok
Checked 65 endpoint(s) against Roblox/creator-docs @ bc72ab94f87487eb2f8b6a5d0842708466e30766 (2026-08-28); 7 known-undocumented endpoint(s) skipped.
test every_endpoint_we_call_still_exists_in_the_roblox_spec ... ok

test result: ok. 10 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.87s

@rbx-forge-spec-bot rbx-forge-spec-bot Bot added api-drift The vendored Roblox OpenAPI document moved dependencies Dependency or vendored-artefact updates labels Aug 27, 2026
@rbx-forge-spec-bot
rbx-forge-spec-bot Bot force-pushed the chore/update-openapi branch 3 times, most recently from fd25e2a to d570e3d Compare August 30, 2026 12:00
Upstream Roblox/creator-docs@bc72ab9
(2026-08-28). The catalog is regenerated
from the same vendored bytes, so the two cannot disagree.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api-drift The vendored Roblox OpenAPI document moved dependencies Dependency or vendored-artefact updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant