Struct AuthzPermissionV1 

pub struct AuthzPermissionV1 {
    pub id: GtsInstanceId,
    pub resource_type: String,
    pub action: String,
    pub display_name: String,
}

Base GTS Type for authorization permissions.

Permissions are well-known GTS Instances of this type; declaring gears register them via the gts_instance! macro (preferred, compile-time) or TypesRegistryClient::register (runtime).

GTS Type Identifier: gts.cf.toolkit.authz.permission.v1~

Fields

id: GtsInstanceId

Full GTS Instance Identifier of this permission (e.g. gts.cf.toolkit.authz.permission.v1~cf.mini_chat._.chat_read.v1).

resource_type: String

GTS expression identifying the set of resources this permission applies to. Accepts concrete IDs, wildcard patterns (GTS §3.5), or Query Language predicates (GTS §3.3).

action: String

Concrete action name (lowercase snake_case). No wildcard, no list. Examples: create, read, list, retry_turn, upload_attachment.

display_name: String

Human-readable label for admin UIs. Examples: “Create tenant”, “Retry chat turn”.

Implementations

impl AuthzPermissionV1

pub fn gts_type_id() -> &'static GtsTypeId

Get the GTS type identifier as a static reference.

pub fn gts_schema_id() -> &'static GtsTypeId

👎Deprecated since 0.10.0:

renamed to gts_type_id

Deprecated alias for Self::gts_type_id.

pub fn gts_base_type_id() -> Option<&'static GtsTypeId>

Get the parent (base) type identifier as a static reference. Returns None for base structs (those with base = true).

pub fn gts_base_schema_id() -> Option<&'static GtsTypeId>

👎Deprecated since 0.10.0:

renamed to gts_base_type_id

Deprecated alias for Self::gts_base_type_id.

pub fn gts_make_instance_id(segment: &str) -> GtsInstanceId

Generate a GTS instance ID by appending a segment to the type ID.

impl AuthzPermissionV1

pub fn gts_schema_with_refs_as_string() -> String

Get the JSON Schema with allOf + $ref for inheritance as a JSON string.

pub fn gts_schema_with_refs_as_string_pretty() -> String

Get the JSON Schema with allOf + $ref for inheritance as a pretty-printed JSON string.

impl AuthzPermissionV1

pub fn gts_instance_json(&self) -> Value

Serialize this instance to a serde_json::Value.

pub fn gts_instance_json_as_string(&self) -> String

Serialize this instance to a JSON string.

pub fn gts_instance_json_as_string_pretty(&self) -> String

Serialize this instance to a pretty-printed JSON string.

Trait Implementations

impl<'de> Deserialize<'de> for AuthzPermissionV1

fn deserialize<__D>( __deserializer: __D, ) -> Result<AuthzPermissionV1, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GtsSchema for AuthzPermissionV1

const TYPE_ID: &'static str = "gts.cf.toolkit.authz.permission.v1~"

The GTS type ID for this type (formerly SCHEMA_ID).

const GENERIC_FIELD: Option<&'static str> = None

The name of the field that contains the generic type parameter, if any. For example, BaseEventV1<P> has payload as the generic field.

const GTS_FINAL: bool = false

true if this type declares x-gts-final (not inheritable). Set by #[struct_to_gts_schema] from gts_final = true; read by the derive-from-final compile-time guard.

const GTS_ABSTRACT: bool = false

true if this type declares x-gts-abstract (not directly instantiable). Set by #[struct_to_gts_schema] from gts_abstract = true; read by the gts_instance! compile-time guard.

const TRAIT_SCHEMA: TraitSchemaState

Chain-aggregated x-gts-traits-schema state (this type’s own layer allOf-composed with its ancestors’). Set by #[struct_to_gts_schema]; read by the compile-time guard that rejects traits values when the chain has no usable trait shape (TraitSchemaState::Absent) or prohibits traits (TraitSchemaState::Prohibited).

fn gts_schema_with_refs() -> Value

Returns the JSON schema for this type with $ref references intact.

fn gts_traits_schema() -> Option<Value>

This type’s own declared x-gts-traits-schema, or None if it declares none. The single layer this type contributes — not the chain-aggregated effective trait-schema (the registry composes those along the $id chain via allOf). Overridden by #[struct_to_gts_schema] when traits_schema = … is set.

fn gts_traits() -> Option<Value>

This type’s own declared x-gts-traits values, or None if it resolves none. The single layer this type contributes — not the chain-merged effective traits object. Overridden by #[struct_to_gts_schema] when traits = … is set.

fn gts_schema() -> Value

Returns the composed JSON schema for this type. For types with generic parameters that implement GtsSchema, this returns the schema with the generic field’s type replaced by the nested type’s schema.

fn innermost_type_id() -> &'static str

Get the innermost type ID in a nested generic chain. For BaseEventV1<AuditPayloadV1<PlaceOrderDataV1>>, returns PlaceOrderDataV1’s ID.

fn innermost_schema() -> Value

Get the innermost (leaf) type’s raw schema. For BaseEventV1<AuditPayloadV1<PlaceOrderDataV1>>, returns PlaceOrderDataV1’s schema.

fn gts_schema_with_refs_allof() -> Value

Generate a GTS-style schema with allOf and $ref to base type.

const SCHEMA_ID: &'static str = Self::TYPE_ID

👎Deprecated since 0.10.0:

use TYPE_ID instead

Deprecated alias for Self::TYPE_ID.

fn innermost_schema_id() -> &'static str

👎Deprecated since 0.10.0:

renamed to innermost_type_id

Deprecated alias for Self::innermost_type_id.

fn collect_nesting_path() -> Vec<&'static str>

Collect the nesting path (generic field names) from outer to inner types. For BaseEventV1<AuditPayloadV1<PlaceOrderDataV1>>, returns ["payload", "data"].

fn outer_generic_path() -> Vec<&'static str>

Path of generic-slot field names from the document root (the outermost base type in the chain) down to where this type’s own properties live in a composed instance.

fn wrap_in_nesting_path( path: &[&str], properties: Value, required: Value, generic_field: Option<&str>, ) -> Value

Wrap properties in a nested structure following the nesting path. For path ["payload", "data"] and properties {order_id, product_id, last}, returns { "payload": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": false, "properties": {...}, "required": [...] } } } }

impl JsonSchema for AuthzPermissionV1

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for AuthzPermissionV1

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.