Improve Swagger For Dashboard Filter State & Permalink

[geido]

Description

Our Swagger instance 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.

We hope that by improving the documentation for these two endpoints, they can serve as a foundation for the other endpoints, eventually leading to an overall improvement of the Swagger documentation.

[msyavuz]

Hey, i am working on it.