Custom Api

[darshan200]

Hi @mistercrunch, how to add a custom api in the ReportScheduleRestApi class that is under superset -> reports -> api.py file

[dosubot[bot]]

I found two similar unsolved discussions that might be relevant to your question:

1. Issue Registering Custom API Endpoint in Apache Superset ^[1].
2. How to add a custom api? ^[2].

To add a custom API endpoint in the ReportScheduleRestApi class, you can follow these steps:

1. Import Necessary Modules: Ensure you have the necessary imports in your api.py file. This includes decorators and classes for handling requests and permissions.

2. Define the Endpoint: Use the @expose decorator to define your new API endpoint. Specify the URL path and HTTP methods. For example:

   @expose("/custom_endpoint", methods=("GET",))
   @protect()
   @safe
   @permission_name("custom_permission")
   def custom_endpoint(self) -> Response:
       # Your implementation here
       return self.response(200, message="Custom endpoint response")

3. Handle Permissions: Use the @permission_name decorator to specify the permissions required to access this endpoint.

4. Implement Logic: Inside the method, implement the logic you want to execute when the endpoint is called.

5. Test the Endpoint: After adding the endpoint, test it to ensure it works as expected. You might need to add tests in the appropriate test files.

These steps should help you add a custom API endpoint to the ReportScheduleRestApi class.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}