team_property_templates.stone

namespace team

import properties

#
# Property Group Template Routes
#

route properties/template/add(AddPropertyTemplateArg, AddPropertyTemplateResult, properties.ModifyPropertyTemplateError)
    "Add a property template. See route files/properties/add to add properties to a file."

    attrs
        auth="team"
        api_group="properties"
        is_preview=true
        owner="dev-plat"

route properties/template/update(UpdatePropertyTemplateArg, UpdatePropertyTemplateResult, properties.ModifyPropertyTemplateError)
    "Update a property template. This route can update the template name,
    the template description and add optional properties to templates."

    attrs
        auth="team"
        api_group="properties"
        is_preview=true
        owner="dev-plat"

route properties/template/get(properties.GetPropertyTemplateArg, properties.GetPropertyTemplateResult, properties.PropertyTemplateError)
    "Get the schema for a specified template."

    attrs
        auth="team"
        api_group="properties"
        is_preview=true
        owner="dev-plat"

route properties/template/list(Void, properties.ListPropertyTemplateIds, properties.PropertyTemplateError)
    "Get the property template identifiers for a team. To get the schema of
    each template use :route:`properties/template/get`."

    attrs
        auth="team"
        api_group="properties"
        is_preview=true
        owner="dev-plat"

struct AddPropertyTemplateArg extends properties.PropertyGroupTemplate
    "Arguments for adding property templates."

    example default
        name = "Security"
        description = "These properties describe how confidential this file is."
        fields = [default]

struct AddPropertyTemplateResult
    template_id properties.TemplateId
        "An identifier for property template added by :route:`properties/template/add`."

    example default
        template_id = "ptid:1a5n2i6d3OYEAAAAAAAAAYa"

struct UpdatePropertyTemplateArg
    template_id properties.TemplateId
        "An identifier for property template added by :route:`properties/template/add`."
    name String?
        "A display name for the property template. Property template names can
        be up to 256 bytes."
    description String?
        "Description for new property template. Property template descriptions
        can be up to 1024 bytes."
    add_fields List(properties.PropertyFieldTemplate)?
        "This is a list of custom properties to add to the property template.
        There can be up to 64 properties in a single property template."

    example default
        template_id = "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
        name = "New Security Template Name"
        description = "These properties will describe how confidential this file is."
        add_fields = [default]

struct UpdatePropertyTemplateResult
    template_id properties.TemplateId
        "An identifier for property template added by :route:`properties/template/add`."

    example default
        template_id = "ptid:1a5n2i6d3OYEAAAAAAAAAYa"