Problem/Motivation

No api_admin role exists, although the Webships tooling and the docs expect one: drush user:role:add api_admin prints "Unable to load the user_role: api_admin", and an API administrator account gets 403 on the API documentation, /openapi/jsonapi?_format=json and /admin/config/services/webapi. The webships profile shipped the role until 3.0.2, which dropped all its configuration, and no site template picked it up.

Steps to reproduce

  1. Run drush user:role:add api_admin <account>: the role is missing.
  2. Open /admin/config/services/webapi as that account: 403.

Proposed resolution

Ship the role "API administrator" in config/optional with the permissions of the documentation, the OpenAPI document and the settings form, and add it on install and update.

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
  • ❌ Reviewed by a human
  • ❌ Code review by maintainers
  • ❌ Full testing and approval
  • ❌ Credit contributors
  • ❌ Review with the product owner
  • ❌ Update Release Notes
  • ❌ Release

User interface changes

  • N/A

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

  • fix: Ship the api_admin role

AI-Generated: Yes

Comments

rajab natshah created an issue. See original summary.

  • rajab natshah committed 4e61a304 on 1.0.x
    fix: #3637724 Ship the api_admin role
    
    The Webships tooling and the docs...
rajab natshah’s picture

Issue summary: View changes
Status: Active » Fixed

Merged in !7, pipeline 1044430.

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

✅ Released webapi 1.0.2