codeant-ai-for-open-source[bot] commented on code in PR #41897: URL: https://github.com/apache/superset/pull/41897#discussion_r3554813296
########## superset/subjects/api.py: ########## @@ -0,0 +1,123 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +import logging + +from flask_appbuilder.models.sqla.interface import SQLAInterface + +from superset.constants import RouteMethod +from superset.subjects.filters import SubjectAllTextFilter +from superset.subjects.models import Subject +from superset.subjects.schemas import openapi_spec_methods_override +from superset.views.base_api import BaseSupersetModelRestApi + +logger = logging.getLogger(__name__) + + +class SubjectRestApi(BaseSupersetModelRestApi): + """Read-only API for fetching and filtering Subjects. + + Subjects are an internal representation derived from Users, Roles, and + Groups, so this API only exposes read operations (list, get, info, related, + distinct). Access is gated by the ``Subject`` permission, which is granted to Review Comment: **Suggestion:** The class docstring claims the API exposes `related` and `distinct`, but `include_route_methods` only enables `get`, `get_list`, and `info`. This creates a contract mismatch that will mislead callers into invoking endpoints that are not actually registered (resulting in 404/permission confusion). Update the docstring to match the implemented routes, or add those route methods if they are intended to be supported. [docstring mismatch] <details> <summary><b>Severity Level:</b> Major ⚠️</summary> ```mdx - ⚠️ Subject API docstring overstates available endpoints, confusing clients. - ⚠️ Callers may see 404 calling nonexistent related/distinct routes. - ⚠️ Extensions misled about subject filtering capabilities via docstring. ``` </details> <details> <summary><b>Steps of Reproduction ✅ </b></summary> ```mdx 1. Start Superset with this PR deployed so that `SubjectRestApi` is imported and registered via `appbuilder.add_api(SubjectRestApi)` in `superset/initialization/__init__.py:88-112`, giving the Subject REST API a live `/api/v1/security/subject` resource. 2. Inspect the `SubjectRestApi` class docstring in `superset/subjects/api.py:31-37`, which explicitly states that the API "only exposes read operations (list, get, info, related, distinct)", advertising `related` and `distinct` endpoints as available. 3. In the same class, examine `include_route_methods` at `superset/subjects/api.py:41-45`, which only includes `RouteMethod.GET`, `RouteMethod.GET_LIST`, and `RouteMethod.INFO`, omitting `RouteMethod.RELATED` and `RouteMethod.DISTINCT` that are used to register related/distinct routes on other APIs such as `DatasetRestApi` in `superset/datasets/api.py:127-132`. 4. Following the pattern from `DatasetRestApi` (which exposes `related`/`distinct` when those route methods are present), a client or extension developer may attempt to call a Subject-related endpoint like `GET /api/v1/security/subject/related/<column_name>` or the corresponding distinct endpoint; because `SubjectRestApi.include_route_methods` does not include `RouteMethod.RELATED` or `RouteMethod.DISTINCT`, Flask-AppBuilder never registers these routes, and the caller receives a 404, contradicting the behavior promised by the docstring. ``` </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=1eb8635c7bb741e3b582752559598f03&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=1eb8635c7bb741e3b582752559598f03&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** superset/subjects/api.py **Line:** 33:35 **Comment:** *Docstring Mismatch: The class docstring claims the API exposes `related` and `distinct`, but `include_route_methods` only enables `get`, `get_list`, and `info`. This creates a contract mismatch that will mislead callers into invoking endpoints that are not actually registered (resulting in 404/permission confusion). Update the docstring to match the implemented routes, or add those route methods if they are intended to be supported. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41897&comment_hash=6f5c81fe702ea98a9ac3bb1283bd6ce45eb929f4f88fd03bb2a97e4957721606&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41897&comment_hash=6f5c81fe702ea98a9ac3bb1283bd6ce45eb929f4f88fd03bb2a97e4957721606&reaction=dislike'>👎</a> -- 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]
