← Back to issue list

Document list of valid ACLs

View original Github issue

Metadata

Project
snapcraft
Number
#5732
Type
issue
State
closed
Author
dilyn-corner
Labels
Status: Triaged Type: Documentation
Created
Updated
Closed

Current evaluation

Resolved in PR #6136 (commit e40e68f37) by linking the Authenticate guide’s credentials-export section to the Snap API reference for valid ACL choices.

Resolution: closed resolved

Reason: PR #6136 was merged as commit e40e68f37, adding the requested ACL documentation link without duplicating the API-owned list in Snapcraft.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Currently the documentation makes reference to the ACLs of a credentials file, but doesn't provide a list of valid choices. Indeed, the only way most people can probably figure this out is after logging in by reviewing what their (presumably unrestricted) credentials give them access to. I *think* a valid list is documented [here](https://dashboard.snapcraft.io/docs/reference/v1/macaroon.html?highlight=acls#post--dev-api-acl-). It may be wise to include a link to [this](https://documentation.ubuntu.com/snapcraft/stable/reference/commands/export-login/*) page and document them there? @medubelko --- *Reported from: https://documentation.ubuntu.com/snapcraft/stable/how-to/publishing/authenticate/*

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Resolved in PR #6136 (commit e40e68f37) by linking the Authenticate guide’s credentials-export section to the Snap API reference for valid ACL choices.
stealth/space-bunny-alpha — closed resolved Valid ACL choices are now linked to the Snap API reference in the authentication guide and export-login help; merged in #6136 as e40e68f37.
stealth/space-bunny-alpha — closed resolved Documented valid export-login ACL choices by linking the Authenticate how-to and the CLI overview to the Snap Store macaroon ACL API reference; merged in PR #6136 (commit e40e68f37).
stealth/space-bunny-alpha — closed resolved Documented valid ACL choices by linking the Authenticate guide and export-login CLI help to the Snap API ACL reference; merged in #6136 as e40e68f37.
stealth/space-bunny-alpha — closed resolved Documentation request resolved by adding a link to the Snap API ACL reference in the Authenticate how-to guide's --acls entry, merged in PR #6136 (commit e40e68f37).
stealth/space-bunny-alpha — closed resolved Documented valid ACL choices by linking the Authenticate guide and export-login help to the Snap API ACL reference; fixed by merged PR #6136 (e40e68f37).
stealth/space-bunny-alpha — closed resolved Documented valid ACL choices by linking the Authenticate guide to the Snap API reference, merged in #6136 (e40e68f37).
qwen/qwen3.6-35b-a3b — — Closed. Maintainer clarified CLI help text is auto-generated and too short for ACL lists, recommending documentation in the Authenticate how-to guide linked to the Snap API. Reassigned to a contributor.
qwen/qwen3.6-35b-a3b — — Closed and resolved via a documentation update plan. Maintainers directed contributors to document valid ACLs in the Authenticate how-to guide and link to the Snap API page, avoiding duplication in the auto-generated CLI help text. Assigned to @canon-cat.
qwen/qwen3.6-35b-a3b — — Accepted and assigned to a contributor to update the Authenticate how-to guide with the valid ACL list and a link to the Snap API documentation, since CLI help text cannot hold the full list.
qwen3.6-35b-a3b-mtp-q6 — — The request to document valid ACLs was assigned to @canon-cat and closed. The team resolved it by documenting the ACLs in the Authenticate how-to guide and linking to the Snap API reference, rather than updating CLI help text.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/snapcraft#6136 (confidence 100%)

    Merged documentation change adding the valid-ACL reference requested in issue #5732.

Related issues

Issue Project State Summary Similarity
#6136 fix(docs): link to the list of valid ACLs (#5732) snapcraft merged Merged #6136 as commit e40e68f37, linking the authentication docs and CLI help to the valid ACL list and fixing #5732.
76%