Skip to content

Fix attribution source enum colliding with reading list enum in OpenAPI schema #655

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

Merged
bpepple merged 1 commit into from
Oct 16, 2026
Merged

Fix attribution source enum colliding with reading list enum in OpenAPI schema #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion metron/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,9 @@
"url": "https://creativecommons.org/licenses/by-sa/4.0/",
},
"ENUM_NAME_OVERRIDES": {
"AttributionSourceEnum": "api.v1_0.serializers.attribution.SOURCE_CHOICES",
# Pin the reading list's enum so the resource attribution enum below can't claim its name.
"AttributionSourceEnum": "reading_lists.models.ReadingList.AttributionSource",
"ResourceAttributionSourceEnum": "api.v1_0.serializers.attribution.SOURCE_CHOICES",
"CurrencyEnum": "metron.choices.CURRENCY_CHOICES",
"DesiredGradeEnum": "user_collection.models.GRADE_CHOICES",
},
Expand Down
5 changes: 4 additions & 1 deletion tests/comicsdb/test_api_attribution.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from api.cache import ModelLabel, get_model_version
from api.v1_0.serializers.attribution import SOURCE_NAMES
from comicsdb.models import Attribution, Character, Publisher, Rating
from reading_lists.models import ReadingList

# (fixture name, API basename) for every resource whose detail response embeds attribution.
ATTRIBUTED_RESOURCES = [
Expand Down Expand Up @@ -248,8 +249,10 @@ def test_attribution_queryset_delete_bumps_each_parent_once(batman, superman, lo

def test_schema_names_attribution_source_enum(db):
schemas = SchemaGenerator().get_schema(request=None, public=True)["components"]["schemas"]
assert schemas["AttributionSourceEnum"]["enum"] == list(SOURCE_NAMES.values())
assert schemas["ResourceAttributionSourceEnum"]["enum"] == list(SOURCE_NAMES.values())
assert "SourceEnum" not in schemas
# The reading list's attribution_source enum keeps its name and its own choices.
assert schemas["AttributionSourceEnum"]["enum"] == ReadingList.AttributionSource.values


def test_unknown_source_code_falls_back_to_stored_value(
Expand Down
Loading