Interface Resource

interface Resource {
    deprecationMessage: string;
    description: string;
    draftMessage: string;
    isDeprecated: boolean;
    isDraft: boolean;
    isUndocumented: boolean;
    properties: Property[];
    propertyGroups: Record<string, PropertyGroup>;
    resourceSamples: {
        description: string;
        properties: Record<string, Json>;
        resource: Partial<Record<
            | "ruby"
            | "javascript"
            | "python"
            | "php"
            | "seam_cli"
            | "go"
            | "java"
            | "csharp"
            | "curl", {
            resource_data: string;
            resource_data_syntax:
                | "ruby"
                | "json"
                | "javascript"
                | "python"
                | "php"
                | "go"
                | "java"
                | "csharp"
                | "bash";
            title: string;
        }>>;
        resource_type: string;
        title: string;
    }[];
    resourceType: string;
    routePath: string;
    undocumentedMessage: string;
}

Hierarchy (view full)

Properties

deprecationMessage

deprecationMessage: string

description

description: string

draftMessage

draftMessage: string

isDeprecated

isDeprecated: boolean

isDraft

isDraft: boolean

isUndocumented

isUndocumented: boolean

properties

properties: Property[]

propertyGroups

propertyGroups: Record<string, PropertyGroup>

resourceSamples

resourceSamples: {
    description: string;
    properties: Record<string, Json>;
    resource: Partial<Record<
        | "ruby"
        | "javascript"
        | "python"
        | "php"
        | "seam_cli"
        | "go"
        | "java"
        | "csharp"
        | "curl", {
        resource_data: string;
        resource_data_syntax:
            | "ruby"
            | "json"
            | "javascript"
            | "python"
            | "php"
            | "go"
            | "java"
            | "csharp"
            | "bash";
        title: string;
    }>>;
    resource_type: string;
    title: string;
}[]

resourceType

resourceType: string

routePath

routePath: string

undocumentedMessage

undocumentedMessage: string

Settings

Member Visibility

On This Page

deprecationMessagedescriptiondraftMessageisDeprecatedisDraftisUndocumentedpropertiespropertyGroupsresourceSamplesresourceTyperoutePathundocumentedMessage
""