diff --git a/nix/stackpanel/db/schemas/dns.proto.nix b/nix/stackpanel/db/schemas/dns.proto.nix index 35ded50b..4cb667e7 100644 --- a/nix/stackpanel/db/schemas/dns.proto.nix +++ b/nix/stackpanel/db/schemas/dns.proto.nix @@ -53,7 +53,7 @@ proto.mkProtoFile { name = "Dns"; description = "DNS records and domain configuration"; fields = { - default_ttl = proto.int32 1 "Default TTL for records (seconds)"; + default_ttl = proto.withExample 300 (proto.int32 1 "Default TTL for records (seconds)"); zones = proto.map "string" "Zone" 2 "DNS zones/domains configuration"; }; }; @@ -63,11 +63,11 @@ proto.mkProtoFile { name = "Zone"; description = "DNS zone configuration"; fields = { - domain = proto.string 1 "Domain name (e.g., 'example.com')"; + domain = proto.withExample "stackpanel.com" (proto.string 1 "Domain name (e.g., 'example.com')"); provider = proto.message "DnsProvider" 2 "DNS provider"; - zone_id = proto.optional (proto.string 3 "Provider-specific zone ID (if required)"); + zone_id = proto.optional (proto.withExample "abcd1234abcd1234abcd1234abcd1234" (proto.string 3 "Provider-specific zone ID (if required)")); records = proto.repeated (proto.message "Record" 4 "List of DNS records for this zone"); - managed = proto.bool 5 "Whether stackpanel manages this zone"; + managed = proto.withExample true (proto.bool 5 "Whether stackpanel manages this zone"); }; }; @@ -77,12 +77,12 @@ proto.mkProtoFile { description = "DNS record configuration"; fields = { type = proto.message "RecordType" 1 "DNS record type"; - name = proto.string 2 "Record name (subdomain or @ for root)"; - value = proto.string 3 "Record value (IP, hostname, or text content)"; - ttl = proto.int32 4 "Time to live in seconds"; - priority = proto.optional (proto.int32 5 "Priority for MX/SRV records"); - proxied = proto.bool 6 "Whether to proxy through CDN (Cloudflare-specific)"; - comment = proto.optional (proto.string 7 "Optional comment describing this record"); + name = proto.withExample "studio" (proto.string 2 "Record name (subdomain or @ for root)"); + value = proto.withExample "76.76.21.21" (proto.string 3 "Record value (IP, hostname, or text content)"); + ttl = proto.withExample 300 (proto.int32 4 "Time to live in seconds"); + priority = proto.optional (proto.withExample 10 (proto.int32 5 "Priority for MX/SRV records")); + proxied = proto.withExample true (proto.bool 6 "Whether to proxy through CDN (Cloudflare-specific)"); + comment = proto.optional (proto.withExample "Studio UI front-end" (proto.string 7 "Optional comment describing this record")); }; }; }; diff --git a/nix/stackpanel/db/schemas/external/github-collaborators.proto.nix b/nix/stackpanel/db/schemas/external/github-collaborators.proto.nix index 76f2b5e8..40295ce2 100644 --- a/nix/stackpanel/db/schemas/external/github-collaborators.proto.nix +++ b/nix/stackpanel/db/schemas/external/github-collaborators.proto.nix @@ -47,8 +47,8 @@ proto.mkProtoFile { name = "Meta"; description = "Metadata about this generated file"; fields = { - source = proto.string 1 "GitHub repository source (e.g., github:owner/repo)"; - generated_at = proto.string 2 "ISO 8601 timestamp of when this file was generated"; + source = proto.withExample "github:darkmatter/stackpanel" (proto.string 1 "GitHub repository source (e.g., github:owner/repo)"); + generated_at = proto.withExample "2026-04-30T18:21:04Z" (proto.string 2 "ISO 8601 timestamp of when this file was generated"); }; }; @@ -57,11 +57,11 @@ proto.mkProtoFile { name = "Collaborator"; description = "A GitHub collaborator"; fields = { - login = proto.string 1 "GitHub username/login"; - id = proto.int64 2 "GitHub user ID"; + login = proto.withExample "cooperdavis" (proto.string 1 "GitHub username/login"); + id = proto.withExample 1234567 (proto.int64 2 "GitHub user ID"); role = proto.message "CollaboratorRole" 3 "Repository permission level"; - is_admin = proto.bool 4 "Whether this user has admin permissions"; - public_keys = proto.repeated (proto.string 5 "SSH public keys from GitHub"); + is_admin = proto.withExample true (proto.bool 4 "Whether this user has admin permissions"); + public_keys = proto.repeated (proto.withExample "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI cooper@darkmatter" (proto.string 5 "SSH public keys from GitHub")); }; }; }; diff --git a/nix/stackpanel/db/schemas/secrets.proto.nix b/nix/stackpanel/db/schemas/secrets.proto.nix index ed46b8a7..0ff59db3 100644 --- a/nix/stackpanel/db/schemas/secrets.proto.nix +++ b/nix/stackpanel/db/schemas/secrets.proto.nix @@ -124,24 +124,24 @@ proto.mkProtoFile { ''; fields = { age_pub = proto.optional ( - proto.string 1 '' + proto.withExample "age1abc1234abc1234abc1234abc1234abc1234abc1234abc1234abc1" (proto.string 1 '' Deprecated. Group-level public keys are no longer used. - '' + '') ); ssm_path = proto.optional ( - proto.string 2 '' + proto.withExample "/stackpanel/keys/dev" (proto.string 2 '' Deprecated. Group-level private keys are no longer used. - '' + '') ); ref = proto.optional ( - proto.string 3 '' + proto.withExample "ref+awsssm:///stackpanel/keys/dev" (proto.string 3 '' Deprecated. Group-level private keys are no longer used. - '' + '') ); key_cmd = proto.optional ( - proto.string 4 '' + proto.withExample "op read 'op://vault/stackpanel/age-key'" (proto.string 4 '' Deprecated. Group-level private keys are no longer used. - '' + '') ); }; }; diff --git a/nix/stackpanel/db/schemas/users.proto.nix b/nix/stackpanel/db/schemas/users.proto.nix index 065c9513..72434c5a 100644 --- a/nix/stackpanel/db/schemas/users.proto.nix +++ b/nix/stackpanel/db/schemas/users.proto.nix @@ -40,11 +40,11 @@ proto.mkProtoFile { name = "User"; description = "A team member with access to the project"; fields = { - name = proto.string 1 "Display name of the user"; - github = proto.optional (proto.string 2 "GitHub username"); - email = proto.optional (proto.string 3 "Email address"); - public-keys = proto.repeated (proto.string 4 "SSH or AGE public keys for the user"); - secrets-allowed-environments = proto.repeated (proto.string 5 "Environments this user can access secrets for (e.g., dev, staging, production)"); + name = proto.withExample "Cooper Davis" (proto.string 1 "Display name of the user"); + github = proto.optional (proto.withExample "cooperdavis" (proto.string 2 "GitHub username")); + email = proto.optional (proto.withExample "cooper@darkmatter.io" (proto.string 3 "Email address")); + public-keys = proto.repeated (proto.withExample "age1abc1234abc1234abc1234abc1234abc1234abc1234abc1234abc1" (proto.string 4 "SSH or AGE public keys for the user")); + secrets-allowed-environments = proto.repeated (proto.withExample "dev" (proto.string 5 "Environments this user can access secrets for (e.g., dev, staging, production)")); }; };