docs(oo): comment where the new helpers are used

- link.go/links.go: third-party doc packs (fileid links), id-stability caveat
- auth.go AuthenticateAs / users check: email-vs-userName login finding
- projects files replace-in: version-history rationale
This commit is contained in:
2026-09-22 22:41:14 +01:00
parent df38b75011
commit 520d6d05c8
5 changed files with 33 additions and 5 deletions
+7 -2
View File
@@ -319,8 +319,13 @@ func usersCheckCmd() *cobra.Command {
Use: "check",
Short: "Check that a login can authenticate (userName or email)",
Long: `Probes POST /api/2.0/authentication.json with the given credentials and
discards the token. On this portal the account email is the reliable login
identifier (userName login may fail); use this before sharing credentials.`,
discards the token.
Where this is used: before handing portal credentials to an external party
(e.g. a landlord given read access to the apartment document pack), verify the
login actually works. On the arc-1 portal the account email is the reliable
login identifier — the userName login fails with 500 for a freshly created
user, so share the email, not the userName.`,
RunE: func(cmd *cobra.Command, args []string) error {
if login == "" {
return fmt.Errorf("--login is required (userName or email)")