geido opened a new issue, #32046: URL: https://github.com/apache/superset/issues/32046
## Description Our [Swagger instance](https://superset.apache.org/docs/api/) requires improvements to enhance usability and developer experience. Currently, the API documentation lacks clarity in some areas, with missing request/response examples, incomplete descriptions, and limited guidance on how to interact with various endpoints. ## Problems Identified - Lack of Examples: Many API endpoints do not include sample request bodies or expected responses, making it difficult for developers to understand the expected payloads. - Unclear Parameter Documentation: Some parameters are not well described, leading to confusion about required vs. optional fields. In particular, we have received requests to improve the documentation for the Dashboard filter_state and permalink endpoints that can be leveraged for use cases such as generating a `native_filters_key` or `permalink_key` to use along Embedded dashboards. -- 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]
