docs(api): cut comments to what the code cannot say

Comments carry the mechanism, not the rationale; every argument removed
here is in the design proposal or the PR. Where one claim appeared at
several sites, the copy at the site that constrains the code stays.

Assisted-by: LLM
Signed-off-by: Timofei Larkin <lllamnyp@gmail.com>
This commit is contained in:
Timofei Larkin authored and IvanHunters committed 2026-11-17 12:07:14 +03:00
1 parent 5b86018cb0
commit c96b91f67a
17 files changed
+58 -99

No files matched your search

@@ -21,11 +21,8 @@ import (
)
// ApplicationDefinitionCredentials declares the accounts of an application
// kind and how the Cozystack API stores their passwords. Its presence is what
// converts the kind: the API seeds one account Secret per account when an
// application is written, serves a core.cozystack.io Credential per account,
// and mints a password on request. The chart renders only references to the
// account Secrets and never a password. See
// kind and how the Cozystack API stores their passwords. Its presence converts
// the kind to platform-minted credentials. See
// design-proposals/user-secrets-api in cozystack/community.
type ApplicationDefinitionCredentials struct {
// Format is how a password is stored in the account Secret: the verifier the
@@ -62,8 +59,7 @@ const (
// CredentialFormatBuiltIn names a function compiled into the API.
CredentialFormatBuiltIn CredentialFormatKind = "BuiltIn"
// CredentialFormatWebhook names an endpoint the API calls with the
// plaintext. Declared so a block can carry it without a schema change; the
// API refuses to serve a kind that uses it until the call is implemented.
// plaintext. Declared, not served yet.
CredentialFormatWebhook CredentialFormatKind = "Webhook"
)
+1 -2
View File
@@ -62,8 +62,7 @@ type ApplicationDefinitionSpec struct {
// Dashboard configuration for this resource
Dashboard *ApplicationDefinitionDashboard `json:"dashboard,omitempty"`
// Credentials declares the kind's accounts and how the API stores their
// passwords. Its presence converts the kind to platform-minted credentials.
// Credentials converts the kind to platform-minted credentials.
// +optional
Credentials *ApplicationDefinitionCredentials `json:"credentials,omitempty"`
}