design

Documentation

Index

• Variables

Variables

var Authentified = Interceptor("Authentified", func() {
	Description("Server-side interceptor that validates JWT token for HTTP services")
})

var IsAdmin = Interceptor("IsAdmin", func() {
	Description("Server-side interceptor that checks if the user has admin privileges")
})

var RoleType = Type("Role", func() {
	Attribute("id", Int, "Unique identifier for the role", func() {
		Example(1)
	})
	Attribute("name", String, "Name of the role", func() {
		Example("admin")
	})
	Attribute("color", String, "Color associated with the role", func() {
		Example("#FF5733")
	})
	Attribute("admin", Boolean, "Is this role an admin role?", func() {
		Default(false)
	})
	Attribute("created_at", String, "Role creation timestamp", func() {
		Example("2025-06-30T12:00:00Z")
	})
	Attribute("updated_at", String, "Role last update timestamp", func() {
		Example("2025-06-30T15:00:00Z")
	})

	Required("id", "name", "color", "admin", "created_at", "updated_at")
})

var SecretInfoSummaryType = Type("SecretInfoSummary", func() {
	Attribute("path", String, "The original path of the secret", func() {
		Example("customers/google/api_key")
	})

	Attribute("owner", UserType, "The owner of the secret")
	Attribute("created_at", String, "Creation timestamp of the secret", func() {
		Example("2025-06-30T12:00:00Z")
	})
	Attribute("updated_at", String, "Last update timestamp of the secret", func() {
		Example("2025-06-30T15:00:00Z")
	})

	Attribute("users", ArrayOf(UserType), "Users authorized to access the secret")
	Attribute("roles", ArrayOf(RoleType), "Roles authorized to access the secret")

	Required("path", "owner", "created_at", "updated_at", "users", "roles")
})

var SecretInfoType = Type("SecretInfo", func() {
	Attribute("path", String, "The original path of the secret", func() {
		Example("customers/google/api_key")
	})

	Attribute("owner", UserType, "The owner of the secret")
	Attribute("authorized_users", ArrayOf(UserType), "Members authorized to access the secret")
	Attribute("authorized_roles", ArrayOf(RoleType), "Roles authorized to access the secret")
	Attribute("created_at", String, "Creation timestamp of the secret", func() {
		Example("2025-06-30T12:00:00Z")
	})
	Attribute("updated_at", String, "Last update timestamp of the secret", func() {
		Example("2025-06-30T15:00:00Z")
	})

	Required("path", "owner", "authorized_users", "authorized_roles", "created_at", "updated_at")
})

var UserType = Type("User", func() {
	Attribute("id", Int, "Unique identifier for the user", func() {
		Example(1)
	})
	Attribute("username", String, "The username", func() {
		Example("alice")
		MinLength(3)
	})
	Attribute("created_at", String, "User creation timestamp", func() {
		Example("2025-06-30T12:00:00Z")
	})
	Attribute("updated_at", String, "User last update timestamp", func() {
		Example("2025-06-30T15:00:00Z")
	})

	Attribute("roles", ArrayOf(RoleType), "Roles assigned to the user")

	Required("id", "username", "created_at", "updated_at", "roles")
})