Skip to content

feat(proto): add examples to remaining schema fields #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cooper (czxtm) merged 1 commit into from
May 2, 2026
+29 −29
Merged

feat(proto): add examples to remaining schema fields #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions nix/stackpanel/db/schemas/dns.proto.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
};
};
Expand All @@ -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");
};
};

Expand All @@ -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"));
};
};
};
Expand Down
12 changes: 6 additions & 6 deletions nix/stackpanel/db/schemas/external/github-collaborators.proto.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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");
};
};

Expand All @@ -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"));
};
};
};
Expand Down
16 changes: 8 additions & 8 deletions nix/stackpanel/db/schemas/secrets.proto.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
''
'')
);
};
};
Expand Down
10 changes: 5 additions & 5 deletions nix/stackpanel/db/schemas/users.proto.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)"));
};
};

Expand Down
Loading