shivamgoel opened a new pull request, #43788:
URL: https://github.com/apache/superset/pull/43788
### SUMMARY
The committed OpenAPI snapshot has drifted well behind the code.
Regenerating with
`superset update-api-docs` documents **39 endpoints** that were missing, and
removes two that no
longer exist: `UserRegistrationsRestAPI.include_route_methods` excludes
`RELATED` and `DISTINCT`, so
`/api/v1/security/user_registrations/{distinct,related}/{column_name}` are
documented but return 404.
Regenerating also surfaced four schemas that route docstrings `$ref` but
nothing declares, which made
`update-api-docs` emit dangling references. This registers them — the three
dashboard config update
schemas via `openapi_spec_component_schemas`, and
`get_slack_channels_schema` via
`apispec_parameter_schemas`. The regenerated spec now resolves every `$ref`.
Most of the diff is reordering rather than content. The snapshot predates
the current serializer,
which writes sorted keys, so regeneration rewrites the file even where
nothing changed. Output is
deterministic: regenerating twice produces an identical file.
### TESTING INSTRUCTIONS
```bash
superset update-api-docs
git diff --stat docs/static/resources/openapi.json # expect no further
change
```
To confirm the two removed routes are genuinely gone:
```python
[r.rule for r in app.url_map.iter_rules() if "user_registrations" in r.rule]
# -> only /, /_info, /<pk>
```
To confirm no dangling references remain, load the spec and check that every
`#/components/schemas/...` reference resolves against `components.schemas`.
### ADDITIONAL INFORMATION
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in
[SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
