Skip to content

Improve OpenAPI documentation grouping #2398

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.

Sign up for GitHub

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

Open
tomi-rli wants to merge 4 commits into
base: develop
Choose a base branch
from
+257 −40
Open

Improve OpenAPI documentation grouping #2398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
afea9cf
Improve OpenAPI documentation grouping
tomi-rli Jun 30, 2026
7b4b324
Merge branch 'develop' into feature-1971-api-documentation
tomi-rli Aug 3, 2026
f69e7cf
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 3, 2026
f539d41
fix merge conflict
tomi-rli Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions api/serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,15 @@ def get_metadata(self, obj):
class DatasetCreateSerializer(serializers.Serializer):
# the name is the dataset's permanent identifier (URL key, oemetadata
# name) and is immutable after creation
name = serializers.SlugField()
title = serializers.CharField()
description = serializers.CharField()
at_id = serializers.URLField(required=False)
name = serializers.SlugField(help_text="Name of the dataset")
title = serializers.CharField(
help_text="Anzeigename des Datensatzes, z. B. 'Wind Power Dataset Germany'"
)
description = serializers.CharField(help_text="Kurze Beschreibung des Datensatzes")
at_id = serializers.URLField(
required=False,
help_text="Optional: Persistenter Identifier oder URL für den Datensatz",
)


class DatasetUpdateSerializer(serializers.Serializer):
Expand Down
23 changes: 23 additions & 0 deletions api/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@
""" # noqa: 501

from django.urls import include, path, re_path
from drf_spectacular.views import (
SpectacularAPIView,
SpectacularRedocView,
SpectacularSwaggerView,
Comment on lines +18 to +21

@jh-RLI jh-RLI Aug 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should only offer one of these, i think.

)

from api.views import (
AdvancedCloseAllAPIView,
Expand Down Expand Up @@ -265,6 +270,24 @@
]

urlpatterns_v0 = [
# OpenAPI Schema (JSON)
path(
"schema/",
SpectacularAPIView.as_view(),
name="openapi-schema",
),
# Swagger UI
path(
"open-api/",
SpectacularSwaggerView.as_view(url_name="api:openapi-schema"),
name="swagger-ui",
),
# Redoc UI
path(
"redoc/",
SpectacularRedocView.as_view(url_name="api:openapi-schema"),
name="redoc",
),
# PROBLEM: redirect does not work with POST/PUT/..., only GET
# so we cannot redirect
re_path( # legacy API url for tables
Expand Down
250 changes: 215 additions & 35 deletions api/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,13 @@
from django.shortcuts import get_object_or_404
from django.utils.decorators import method_decorator
from django.views.decorators.cache import never_cache
from drf_spectacular.utils import (
OpenApiExample,
OpenApiParameter,
OpenApiResponse,
extend_schema,
extend_schema_view,
)
from oemetadata.latest.example import OEMETADATA_LATEST_EXAMPLE
from oemetadata.latest.template import OEMETADATA_LATEST_TEMPLATE
from rest_framework import generics, status
Expand Down Expand Up @@ -209,6 +216,10 @@
logger = logging.getLogger("oeplatform")


@extend_schema_view(
get=extend_schema(tags=["Schema: Meta"]),
post=extend_schema(tags=["Schema: Meta"]),
)
class TableMetadataAPIView(APIView):
"""
Important note:
Expand Down Expand Up @@ -294,6 +305,34 @@ def load_owned_dataset_from_request(request, dataset_name: str):
return dataset, serializer.validated_data["tables"]


@extend_schema_view(
post=extend_schema(
summary="Create dataset",
description="Creates a new dataset.",
request=DatasetCreateSerializer,
responses={},
examples=[
OpenApiExample(
"Dataset Example",
summary="Example request body for " "creating a dataset",
description=(
"Use this JSON object to create a new dataset. "
"The `at_id` field is optional and can contain "
"a persistent identifier."
),
value={
"name": "test_dataset",
"title": "Wind Power Dataset Germany",
"description": (
"Contains hourly wind generation " "data for Germany."
),
"at_id": "https://example.org/datasets/test_dataset",
},
request_only=True,
)
],
)
)
class DatasetsListCreate(generics.ListCreateAPIView):
queryset = Dataset.objects.prefetch_related("tables")
permission_classes = [IsAuthenticatedOrReadOnly]
Expand Down Expand Up @@ -321,6 +360,13 @@ def create(self, request, *args, **kwargs):
)


@extend_schema_view(
get=extend_schema(
summary="List dataset resources",
description="Returns the tables/resources that belong to a dataset.",
responses=DatasetResourceSerializer(many=True),
)
)
class DatasetsListResources(generics.ListAPIView):
serializer_class = DatasetResourceSerializer

Expand All @@ -330,6 +376,37 @@ def get_queryset(self):
return dataset.tables.all()


@extend_schema_view(
get=extend_schema(
summary="Get dataset",
description="Returns metadata for a single dataset.",
responses=DatasetReadSerializer,
),
put=extend_schema(
summary="Update dataset",
description="Updates metadata for an existing dataset.",
request=DatasetCreateSerializer,
responses={200: OpenApiResponse(description="Dataset updated")},
examples=[
OpenApiExample(
"Update dataset example",
summary="Example request body for updating a dataset",
value={
"name": "test_dataset",
"title": "Updated Wind Power Dataset Germany",
"description": "Updated description with more details.",
"at_id": "https://example.org/datasets/test_dataset",
},
request_only=True,
)
],
),
delete=extend_schema(
summary="Delete dataset",
description="Deletes the specified dataset.",
responses={204: OpenApiResponse(description="Dataset deleted")},
),
)
class DatasetManager(APIView):
"""
View to retrieve, update, or delete a single dataset's metadata.
Expand Down Expand Up @@ -363,13 +440,57 @@ def delete(self, request, dataset_name):
assert_dataset_ownership(request.user, dataset)
dataset.delete()
return Response(
{"message": "Dataset deleted"}, status=status.HTTP_204_NO_CONTENT
{"message": "Dataset deleted"},
status=status.HTTP_204_NO_CONTENT,
)


class AssignDatasetTables(APIView):
"""
Assign existing OEP tables to an existing dataset.
"""

permission_classes = [IsAuthenticated]

@extend_schema(
summary="Assign tables to dataset",
description=(
"Assigns existing OEP tables to an existing dataset. "
"The dataset must already exist and the referenced "
"tables must already exist. After assignment, the "
"dataset resources are updated from the table metadata."
),
parameters=[
OpenApiParameter(
name="dataset_name",
type=str,
location=OpenApiParameter.PATH,
required=True,
description=(
"Name of the dataset to which the tables should be assigned. "
"Example: `test_dataset`."
),
)
],
request=DatasetAssignTablesSerializer,
responses={
200: OpenApiResponse(description="Tables were assigned to the dataset."),
404: OpenApiResponse(description="Dataset was not found."),
},
examples=[
OpenApiExample(
"Assign tables example",
summary="Example request body for assigning tables",
value={
"tables": [
{"name": "germany_wind_hourly"},
{"name": "germany_wind_daily"},
]
},
request_only=True,
)
],
)
def post(self, request, dataset_name):
dataset, table_refs = load_owned_dataset_from_request(request, dataset_name)
if table_refs is None:
Expand Down Expand Up @@ -1560,6 +1681,7 @@ def get(self, request: Request) -> JsonLikeResponse:
return Response(data, status=status.HTTP_200_OK)


@extend_schema_view(post=extend_schema(tags=["Advanced: Cursor"]))
class AdvancedFetchAPIView(APIView):
@api_exception
def post(self, request: Request, fetchtype) -> JsonLikeResponse:
Expand Down Expand Up @@ -1593,45 +1715,103 @@ def transform_row(self, row):
)


@extend_schema_view(get=extend_schema(tags=["Advanced: Connection"]))
class AdvancedCloseAllAPIView(LoginRequiredMixin, APIView):
@api_exception
def get(self, request: Request) -> JsonLikeResponse:
sessions.close_all_for_user(request.user)
return JsonResponse({"message": "All connections closed"})


AdvancedSearchAPIView = create_ajax_handler(
data_search, allow_cors=True, requires_cursor=True
AdvancedSearchAPIView = extend_schema_view(post=extend_schema(tags=["Advanced"]))(
create_ajax_handler(data_search, allow_cors=True, requires_cursor=True)
)
AdvancedInsertAPIView = extend_schema_view(post=extend_schema(tags=["Advanced"]))(
create_ajax_handler(data_insert, requires_cursor=True)
)
AdvancedDeleteAPIView = extend_schema_view(post=extend_schema(tags=["Advanced"]))(
create_ajax_handler(data_delete, requires_cursor=True)
)
AdvancedUpdateAPIView = extend_schema_view(post=extend_schema(tags=["Advanced"]))(
create_ajax_handler(data_update, requires_cursor=True)
)


AdvancedHasSchemaAPIView = extend_schema_view(post=extend_schema(tags=["Advanced"]))(
create_ajax_handler(has_schema)
)
AdvancedHasTableAPIView = extend_schema_view(post=extend_schema(tags=["Advanced"]))(
create_ajax_handler(has_table)
)
AdvancedGetSchemaNamesAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced"])
)(create_ajax_handler(get_schema_names))
AdvancedGetTableNamesAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced"])
)(create_ajax_handler(get_table_names))
AdvancedGetViewNamesAPIView = extend_schema_view(post=extend_schema(tags=["Advanced"]))(
create_ajax_handler(get_view_names)
)
AdvancedGetViewDefinitionAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced"])
)(create_ajax_handler(get_view_definition))
AdvancedGetColumnsAPIView = extend_schema_view(post=extend_schema(tags=["Advanced"]))(
create_ajax_handler(get_columns)
)
AdvancedGetPkConstraintAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced"])
)(create_ajax_handler(get_pk_constraint))
AdvancedGetForeignKeysAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced"])
)(create_ajax_handler(get_foreign_keys))
AdvancedGetIndexesAPIView = extend_schema_view(post=extend_schema(tags=["Advanced"]))(
create_ajax_handler(get_indexes)
)
AdvancedInsertAPIView = create_ajax_handler(data_insert, requires_cursor=True)
AdvancedDeleteAPIView = create_ajax_handler(data_delete, requires_cursor=True)
AdvancedUpdateAPIView = create_ajax_handler(data_update, requires_cursor=True)

AdvancedHasSchemaAPIView = create_ajax_handler(has_schema)
AdvancedHasTableAPIView = create_ajax_handler(has_table)
AdvancedGetSchemaNamesAPIView = create_ajax_handler(get_schema_names)
AdvancedGetTableNamesAPIView = create_ajax_handler(get_table_names)
AdvancedGetViewNamesAPIView = create_ajax_handler(get_view_names)
AdvancedGetViewDefinitionAPIView = create_ajax_handler(get_view_definition)
AdvancedGetColumnsAPIView = create_ajax_handler(get_columns)
AdvancedGetPkConstraintAPIView = create_ajax_handler(get_pk_constraint)
AdvancedGetForeignKeysAPIView = create_ajax_handler(get_foreign_keys)
AdvancedGetIndexesAPIView = create_ajax_handler(get_indexes)
AdvancedGetUniqueConstraintsAPIView = create_ajax_handler(get_unique_constraints)

AdvancedConnectionOpenAPIView = create_ajax_handler(open_raw_connection)
AdvancedConnectionCloseAPIView = create_ajax_handler(close_raw_connection)
AdvancedConnectionCommitAPIView = create_ajax_handler(commit_raw_connection)
AdvancedConnectionRollbackAPIView = create_ajax_handler(rollback_raw_connection)

AdvancedCursorOpenAPIView = create_ajax_handler(open_cursor)
AdvancedCursorCloseAPIView = create_ajax_handler(close_cursor)
AdvancedCursorFetchOneAPIView = create_ajax_handler(fetchone)

AdvancedSetIsolationLevelAPIView = create_ajax_handler(set_isolation_level)
AdvancedGetIsolationLevelAPIView = create_ajax_handler(get_isolation_level)
AdvancedDoBeginTwophaseAPIView = create_ajax_handler(do_begin_twophase)
AdvancedDoPrepareTwophaseAPIView = create_ajax_handler(do_prepare_twophase)
AdvancedDoRollbackTwophaseAPIView = create_ajax_handler(do_rollback_twophase)
AdvancedDoCommitTwophaseAPIView = create_ajax_handler(do_commit_twophase)
AdvancedDoRecoverTwophaseAPIView = create_ajax_handler(do_recover_twophase)
AdvancedGetUniqueConstraintsAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced"])
)(create_ajax_handler(get_unique_constraints))

AdvancedConnectionOpenAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Connection"])
)(create_ajax_handler(open_raw_connection))
AdvancedConnectionCloseAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Connection"])
)(create_ajax_handler(close_raw_connection))
AdvancedConnectionCommitAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Connection"])
)(create_ajax_handler(commit_raw_connection))
AdvancedConnectionRollbackAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Connection"])
)(create_ajax_handler(rollback_raw_connection))

AdvancedCursorOpenAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Cursor"])
)(create_ajax_handler(open_cursor))
AdvancedCursorCloseAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Cursor"])
)(create_ajax_handler(close_cursor))
AdvancedCursorFetchOneAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Cursor"])
)(create_ajax_handler(fetchone))

AdvancedSetIsolationLevelAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced"])
)(create_ajax_handler(set_isolation_level))
AdvancedGetIsolationLevelAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced"])
)(create_ajax_handler(get_isolation_level))
AdvancedDoBeginTwophaseAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Two phase"])
)(create_ajax_handler(do_begin_twophase))
AdvancedDoPrepareTwophaseAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Two phase"])
)(create_ajax_handler(do_prepare_twophase))
AdvancedDoRollbackTwophaseAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Two phase"])
)(create_ajax_handler(do_rollback_twophase))
AdvancedDoCommitTwophaseAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Two phase"])
)(create_ajax_handler(do_commit_twophase))
AdvancedDoRecoverTwophaseAPIView = extend_schema_view(
post=extend_schema(tags=["Advanced: Two phase"])
)(create_ajax_handler(do_recover_twophase))
10 changes: 9 additions & 1 deletion oeplatform/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@
"owlready2",
"compressor",
"oekg",
"drf_spectacular",
)

MIDDLEWARE = (
Expand Down Expand Up @@ -395,7 +396,14 @@
"rest_framework.authentication.BasicAuthentication",
"rest_framework.authentication.SessionAuthentication",
"rest_framework.authentication.TokenAuthentication",
)
),
# Use drf-spectacular's AutoSchema for generating OpenAPI schema
"DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
}
SPECTACULAR_SETTINGS = {
"TITLE": "Open Energy Platform API",
"DESCRIPTION": "OpenAPI schema for the Open Energy Platform REST API.",
"VERSION": "v0",
}

AUTHENTICATION_BACKENDS = [
Expand Down
Loading
Loading