michael-s-molina commented on code in PR #38516:
URL: https://github.com/apache/superset/pull/38516#discussion_r2906559016
##########
superset-core/README.md:
##########
@@ -31,83 +31,78 @@ The official core package for building Apache Superset
backend extensions and in
pip install apache-superset-core
```
-## 🏗️ Architecture
+## 🏗️ Package Structure
-The package is organized into logical modules, each providing specific
functionality:
-
-- **`api`** - REST API base classes, models access, query utilities, and
registration
-- **`api.models`** - Access to Superset's database models (datasets,
databases, etc.)
-- **`api.query`** - Database query utilities and SQL dialect handling
-- **`api.rest_api`** - Extension API registration and management
-- **`api.types.rest_api`** - REST API base classes and type definitions
+```
+src/superset_core/
+├── common/
+├── extensions/
+├── mcp/
+├── queries/
+├── rest_api/
+├── tasks/
+└── __init__.py
+```
## 🚀 Quick Start
-### Basic Extension Structure
+### Basic Extension API
```python
-from flask import request, Response
from flask_appbuilder.api import expose, permission_name, protect, safe
-from superset_core import common, queries, rest_api
from superset_core.rest_api.api import RestApi
+from superset_core.rest_api.decorators import api
-class DatasetReferencesAPI(RestApi):
- """Example extension API demonstrating core functionality."""
+@api(id="dataset_references", name="Dataset References API")
+class DatasetReferencesAPI(RestApi):
resource_name = "dataset_references"
- openapi_spec_tag = "Dataset references"
- class_permission_name = "dataset_references"
Review Comment:
Removed
--
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]