Skip to content

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

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

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 Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Vendored Roblox OpenAPI document refreshed

Upstream: Roblox/creator-docs@70a0110fee0c0900103e545fcaee69a8bd2a942f (2026-10-17)
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
    Updating crates.io index
 Downloading crates ...
  Downloaded itoa v1.0.18
  Downloaded zmij v1.0.21
  Downloaded serde_core v1.0.228
  Downloaded memchr v2.8.0
  Downloaded serde_json v1.0.149
   Compiling zmij v1.0.21
   Compiling serde_core v1.0.228
   Compiling serde_json v1.0.149
   Compiling itoa v1.0.18
   Compiling memchr v2.8.0
   Compiling rbx-spec-drift v0.11.0 (/home/runner/work/rbx-cli/rbx-cli/crates/rbx-spec-drift)
    Finished `test` profile [unoptimized + debuginfo] target(s) in 2.54s
     Running tests/openapi_drift/main.rs (target/debug/deps/openapi_drift-d425f80fc2d0951c)

running 14 tests
test bodies::every_request_body_matches_the_schema_the_spec_documents ... ok
test coverage::every_listed_endpoint_still_exists_in_the_spec ... ok
6 configs endpoint(s) checked against Roblox/creator-docs @ 70a0110fee0c0900103e545fcaee69a8bd2a942f (2026-10-17).
test configs::every_configs_endpoint_is_documented_in_the_spec ... ok
test coverage::every_documented_endpoint_in_a_covered_area_is_called_or_declined ... ok
test coverage::nothing_is_declined_while_being_called ... ok
test extractor_guards::a_cfg_test_item_hides_itself_and_nothing_after_it ... ok
test extractor_guards::a_mention_in_a_doc_comment_is_not_an_attribute ... ok
test extractor_guards::a_trailing_test_module_is_still_removed_whole ... ok
test coverage::nothing_is_listed_as_helper_built_once_the_extractor_can_see_it ... ok
test extractor_guards::the_item_scanner_is_not_fooled_by_braces_in_strings_or_lifetimes ... ok
test extractor_guards::the_manifest_scan_sees_dependencies_and_ignores_dev_dependencies ... ok
21 crate(s) with an HTTP dependency, 20 contributing endpoints, 1 exempt.
test every_crate_that_calls_roblox_contributes_an_endpoint ... ok
test extractor_guards::engine_avatar_settings_is_still_an_opaque_string ... ok
Checked 72 endpoint(s) against Roblox/creator-docs @ 70a0110fee0c0900103e545fcaee69a8bd2a942f (2026-10-17); 19 known-undocumented endpoint(s) skipped.
test every_endpoint_we_call_still_exists_in_the_roblox_spec ... ok

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

@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 Oct 15, 2026
@rbx-forge-spec-bot
rbx-forge-spec-bot Bot force-pushed the chore/update-openapi branch 2 times, most recently from b5fe1e6 to 3838e61 Compare October 17, 2026 10:53
Upstream Roblox/creator-docs@70a0110
(2026-10-17). The catalog is regenerated
from the same vendored bytes, so the two cannot disagree.

This branch has not been deployed

No deployments
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