Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enabling Swagger and improving the HTTP API. #9066

Open
Neko1313 opened this issue Dec 24, 2024 · 3 comments
Open

Enabling Swagger and improving the HTTP API. #9066

Neko1313 opened this issue Dec 24, 2024 · 3 comments
Labels
api:rest Issues related to REST API enhancement New feature proposal

Comments

@Neko1313
Copy link

Is your feature request related to a problem? Please describe.
Every time I need to review the code and documentation to understand how the REST API and GraphQL work, I get frustrated .

Describe the solution you'd like

  1. I would like to see Swagger appear, which will allow you to conduct experiments directly from the browser.

  2. I would also like the REST API to allow filtering of the received summary data.
    For example, it would be possible to get only data on metrics for all models, or to get all the information for a specific model, knowing only its table name. This would avoid loading a large amount of information at one time, as it happens now.

Additional context
Sample requests

  • All information: /v1/meta
  • Model information: /v1/meta/{NameModel}
  • Information on the model field: /v1/meta/{NameModel}/{Field}
@igorlukanin igorlukanin added enhancement New feature proposal api:rest Issues related to REST API labels Jan 8, 2025
@Neko1313
Copy link
Author

Hi, I would really like to implement the feature faster with the new endpoint, but there is no full immersion in the project, if someone can tell me which files are worth looking at for changes, I can do this part myself

@igorlukanin
Copy link
Member

@Neko1313 I believe taking a look at this package is a good starting point. Also, please feel free to check contribution guidelines.

I would also like the REST API to allow filtering of the received summary data. For example, it would be possible to get only data on metrics for all models, or to get all the information for a specific model, knowing only its table name. This would avoid loading a large amount of information at one time, as it happens now.

As for the feature idea itself, why do you think this is going be useful? Could you please describe a scenario where you only need a subset of meta information? What kind of an application would you use it for?

@Neko1313
Copy link
Author

@igorlukanin This functionality can be useful for integration into user interfaces in order to optimize data transfer. In particular, it can be useful when working with a large number of cubes, when the amount of data becomes redundant.

In addition, I plan to develop an HTTP\dialect for SQLAlchemy in the future, specially adapted for working with Cube.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api:rest Issues related to REST API enhancement New feature proposal
Projects
None yet
Development

No branches or pull requests

2 participants