Problem/Motivation

The default API recipe is currently defined inside the varbase_api module, which mixes feature implementation with installation recipes.

With the move toward clearer separation of concerns and reusable base recipes, the API setup should live in a dedicated Varbase API Base recipe, allowing:

  • Cleaner architecture
  • Easier reuse by other Vardot distributions or recipes
  • Better alignment with Drupal Recipes best practices

Proposed resolution

#3561802: Start an 11.0.x branch for Varbase with Recipe Installer Kit

  • Introduce a new Varbase API Base recipe and migrate the existing default API recipe from the varbase_api module into it.
  • Creating a new recipe named Varbase API Base
  • Moving all API-related module installs, config imports, and actions into the recipe
  • Keeping varbase_api focused on functionality rather than installation logic

Recipe Definition

  • The new recipe (recipe.yml) will:
    • JSON:API
    • Simple OAuth
    • OpenAPI (JSON:API, REST, Redoc, Swagger)
    • REST UI
    • JSON:API Extras & Defaults
  • Install required API, authentication, and documentation modules:
  • Import default configuration for all related modules
  • Apply configuration actions:
    • Configure jsonapi_extras.settings with a default /api prefix and safe defaults
    • Grant API and documentation permissions to the site_admin role

Remaining tasks

  • ✅ File an issue about this project
  • ✅ Addition/Change/Update/Fix to this project
  • ✅ Testing to ensure no regression
  • ✅ Automated unit/functional testing coverage
  • ✅ Developer Documentation support on feature change/addition
  • ➖ User Guide Documentation support on feature change/addition
  • ➖ UX/UI designer responsibilities
  • ➖ Accessibility and Readability
  • ✅ Code review from 1 Varbase core team member
  • ✅ Full testing and approval
  • ✅ Credit contributors
  • ✅ Review with the product owner
  • ✅ Update Release Notes
  • ❌ Release varbase-11.0.0-alpha1, varbase_starter-1.0.0-alpha1, varbase_api_base-1.0.0-alpha1

User interface changes

  • N/A

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

  • feat: #3566427 Initialize Varbase API Base recipe and migrate default API recipe

Comments

rajab natshah created an issue. See original summary.

rajab natshah’s picture

Issue summary: View changes
rajab natshah’s picture

Version: » 1.0.x-dev

  • rajab natshah committed d75892cf on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed ff0cd6ee on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed 22c56054 on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed ecb10a63 on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed 7e74a006 on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed 3c26c9d6 on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed 851cb2f7 on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed a3fd329f on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed 86777705 on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed 8618e7d1 on 1.0.x
    feat: #3566427 Initialize Varbase API Base recipe and migrate default...

  • rajab natshah committed a2ccb910 on 1.0.x
    feat: #3566427 grant Permissions in Varbase API Base recipe for Varbase...
rajab natshah’s picture

Assigned: rajab natshah » josebc
Issue summary: View changes
Status: Active » Needs review
Issue tags: +varbase-11.0.0-alpha1, +varbase_starter-1.0.0-alpha1, +varbase_api_base-1.0.0-alpha1
rajab natshah’s picture

Assigned: josebc » Unassigned
Status: Needs review » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

rajab natshah’s picture

Issue summary: View changes