feat: Add djangocms-rest support

[fsbraun]

Summary by Sourcery

Integrate optional djangocms-rest support to expose alias content via the headless API and ensure Alias plugins serialize correctly through REST endpoints.

New Features:

• Expose alias placeholder content through a dedicated djangocms-rest alias-detail endpoint when djangocms-rest is installed.
• Provide an inline REST serializer for Alias plugins so their referenced alias content is expanded directly in API responses.
• Add a model-level hook returning the REST API endpoint URL for an alias for use by djangocms-rest serializers.

Enhancements:

• Wire djangocms_alias cms and plugin configs to register djangocms-rest endpoints and serializers only when the dependency is present.
• Extend test settings and URL configuration to conditionally mount djangocms-rest, including media and REST framework configuration needed for integration tests.

Tests:

• Add end-to-end tests covering alias REST endpoint behavior, inline alias content serialization, foreign key URL resolution, and recursion guards for circular or nested aliases.

Related resources

• #...
• #...

Checklist

• I have added or modified the tests when changing logic
• I have followed the conventional commits guidelines to add meaningful information into the changelog
• I have read the contribution guidelines

Summary by Sourcery

Integrate optional djangocms-rest support to expose alias content and serialize nested Alias plugins through the headless API.

New Features:

• Add optional djangocms-rest API endpoints for listing aliases and retrieving localized alias placeholder content.
• Expand Alias plugins inline in REST responses and expose alias references through API endpoint URLs.
• Support published and permission-controlled preview access, site-aware static aliases, and recursion-safe nested alias serialization.

Enhancements:

• Integrate REST support lazily so the package remains usable when djangocms-rest is not installed.

Build:

• Refresh pinned test requirements and streamline per-Python dependency compilation through tox.

Documentation:

• Document the new REST integration and usage.

Tests:

• Add end-to-end coverage for alias endpoints, permissions, static alias resolution, foreign-key links, inline serialization, and circular alias protection.

[sourcery-ai]

Reviewer's Guide

Adds optional integration with djangocms-rest, exposing alias placeholders via a headless API endpoint, wiring the Alias plugin to an inline serializer, and providing end-to-end REST tests guarded by conditional imports so behavior is unchanged when djangocms-rest is absent.

Sequence diagram for djangocms-rest alias placeholder API endpoint

sequenceDiagram
    actor Client
    participant Router as DjangoRouter
    participant View as AliasContentView
    participant AliasModel as Alias
    participant PlaceholderSerializer
    participant DRFResponse as Response

    Client->>Router: GET /<language>/aliases/<pk>/
    Router->>View: dispatch get(language, pk)
    View->>AliasModel: objects.filter(pk=pk).first()
    AliasModel-->>View: alias or None
    alt alias is None
        View->>View: raise NotFound
    else alias exists
        View->>AliasModel: get_placeholder(language, show_draft_content)
        AliasModel-->>View: placeholder or None
        alt placeholder is None
            View->>View: raise NotFound
        else placeholder exists
            View->>PlaceholderSerializer: __init__(instance=placeholder, request=request, language=language)
            View->>PlaceholderSerializer: data
            PlaceholderSerializer-->>View: serialized_placeholder
            View->>DRFResponse: __init__(serialized_placeholder)
            DRFResponse-->>Client: 200 OK
        end
    end

Loading

File-Level Changes

Change	Details	Files
Conditionally enable djangocms-rest and related apps/settings in the test project.	Detect djangocms_rest presence in tests.settings and compute HAS_REST/REST_INSTALLED_APPS accordingly Extend INSTALLED_APPS with REST_INSTALLED_APPS so filer, easy_thumbnails, drf_spectacular, and djangocms_rest are loaded when available Add MEDIA_URL and REST-related settings (THUMBNAIL_PROCESSORS, REST_FRAMEWORK, SPECTACULAR_SETTINGS) guarded by HAS_REST Mount djangocms_rest URL patterns under /api/ in tests.urls when the package is installed	tests/settings.py tests/urls.py
Expose alias content over a REST endpoint and integrate with djangocms-rest configuration hooks.	Add Alias.get_api_endpoint method to resolve per-language alias-detail URLs, returning None if the route is unavailable Introduce djangocms_alias.rest module defining AliasContentView, AliasInlineSerializer, and djangocms-rest urlpatterns for alias-detail Wire cms_config to import rest integration conditionally and register cms_rest_endpoints/cms_rest_enabled when present	djangocms_alias/models.py djangocms_alias/cms_config.py djangocms_alias/rest.py
Integrate Alias CMS plugin with djangocms-rest’s plugin serialization pipeline.	Conditionally import AliasInlineSerializer from the new rest module in cms_plugins Assign AliasInlineSerializer as the Alias plugin’s serializer_class so alias content is expanded inline in REST responses while falling back when djangocms-rest is absent	djangocms_alias/cms_plugins.py
Add end-to-end tests covering alias REST integration, serialization, and recursion guards.	Introduce tests/test_rest.py with an AliasRESTIntegrationTestCase that exercises the alias-detail endpoint, 404 behavior, Alias.get_api_endpoint hook, serialize_fk integration, inline serializer wiring, page placeholder expansion, circular alias handling, and recursion-guard behavior Use skipUnless(HAS_REST) gating to ensure tests only run when djangocms_rest is installed	tests/test_rest.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[metaforx]

@fsbraun : I implemented the PR in my test setup. The plugin serialization works as expected. What i do not get is how we serialize a static alias, for example footer. I add one to my base template and either would expect serialization directly in pages or via endpoint and identifier "footer". Currently i can serialize it via id:

http://localhost:8080/api/en/aliases/2/

I would i expect to use the natural language identifiert "footer" similar to use in template:
{% static_alias 'footer' %}
http://localhost:8080/api/en/aliases/footer/

What is your take on this issue? Do i miss something?

[metaforx]

@fsbraun 👍

[sourcery-ai]

Sorry @fsbraun, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 6 days and 11 hours by commenting @sourcery-ai review. Upgrade to get a review now.