File Template Object Model#

Overview#

YAML Structure

Type: Template
Kind: File
Name: 
Metadata:
  Tags:
Specifications:
  Name: 
  Output:
  Set: 
  Layers:
    - Name: 
      Sections:
        - Classes:
  Workspace: None
  Template:
    Content: |
      // Your file content template goes here

Summary

• Type: Must always be Template.
• Kind: Should be File.
• Name: Unique identifier for the template.
• Metadata: Contains Tags for labeling and categorization.
• Specifications:
  • Name: Instance name used in development and generation.
  • Output: Specifies the output file name, can be dynamically set (e.g., {{Resource.Name}}.json).
  • Set: Similar to resource model set, indicates which project group it belongs to.
  • Layers: Specifies which layers it applies to.
  • Sections: Specifies which sections it applies to, with filtering using classes.
  • Workspace: Specifies the workspace where the template is defined. Default is None.
  • Template.Content: Defines the file content template. Can be multiline.

Fields

• type: Template
• kind: File
• name: String
• metadata: Metadata
• specifications: Specifications

Required Fields

• Type
• Kind
• Name
• specifications.name

Field Descriptions#

Type#

Definition

• DataType: String
• Type: fixed-value
• Multiplicity: Required
• Default: Template
• Valid values: Must be Template
• Description: Specifies the type of the model.

Usage

The Type field identifies the model type as a Template.

Notes

• This field is mandatory and must always be set to Template.

Example

Type: Template

Kind#

Definition

• DataType: String
• Type: fixed-value
• Multiplicity: Required
• Default: File
• Valid values: Must be File
• Description: Specifies the kind of the template.

Usage

The Kind field identifies the resource type as an File.

Notes

• This field is mandatory and must always be set to File.

Example

Kind: File

Name#

Definition

• DataType: String
• Type: text
• Multiplicity: Required
• Default: none
• Valid values: Any string value that ensures uniqueness within the environment.
• Description: A unique identifier for the template, assigned by the developer. This name should be unique within the selected environment.

Usage

The Name is used to identify the template and must align with the project architecture and plan.

Notes

• Ensure the Name is unique to avoid conflicts.

Example

Name: DtoTemplate

Metadata#

Definition

• DataType: object
• Type: structured-data
• Multiplicity: Optional
• Default: none
• Description: An object containing metadata about the resource.

Metadata.Tags#

Definition

• DataType: []string
• Type: list
• Multiplicity: Optional
• Default: none
• Description: Labels for the resource, used for filtering, grouping, and selection purposes.

Usage

Use Tags to categorize and manage resources more effectively.

Notes

• Tags can be used for filtering and organizing resources based on specific criteria.

Examples

Metadata:
  Tags:
  - dto
  - template

Specifications#

Definition

• DataType: object
• Type: structured-data
• Multiplicity: Required
• Default: none
• Description: Contains specific details about the template instance.

Specifications.Name#

Definition

• DataType: String
• Type: text
• Multiplicity: Required
• Default: none
• Description: The name given to the template instance. This is used during development or generation processes.

Usage

This Name is used to reference the specific instance of the template.

Notes

• Different from the header Name, which identifies the model.

Example

Specifications:
  Name: ResponseDto

Specifications.Set#

Definition

• DataType: String
• Type: text
• Multiplicity: Optional
• Default: none
• Description: An optional field used to group resources, similar to projects.

Usage

Use Set to group related resources together.

Notes

• Useful for managing related resources in a microservices architecture or monolithic application.

Example

Specifications:
  Set: EShopping

Specifications.Output#

Definition

• DataType: String
• Type: text
• Multiplicity: Required
• Default: none
• Description: Specifies the output file name. Can be dynamically set using templates.

Usage

The Output field specifies the name of the output file. It can use dynamic values from the resource using template syntax.

Notes

• Used to define reusable file templates for common and standard operations.
• Can be imported and used in other templates.

Example

Specifications:
  Output: '{{.Resource.Name}}Dto.ts'

Specifications.Workspace#

Definition

• DataType: String
• Type: text
• Multiplicity: Optional
• Default: None
• Description: Specifies the workspace where the template is defined.

Usage

The Workspace field identifies the workspace in which the template is defined.

Notes

• If not specified, the default value is None.

Example

Specifications:
  Workspace: CommonWorkspace

Specifications.Layers#

Definition

• DataType: array
• Type: list
• Multiplicity: Optional
• Default: none
• Description: Defines layers where only the name is specified.

Usage

Specifies layers to organize the resource's structure.

Notes

• Similar to the layers in projects, but only the name is specified without path and package information.

Example

Specifications:
  Layers:
  - Name: Controllers
  - Name: Services

Specifications.Layers.Sections#

Definition

• DataType: array
• Type: list
• Multiplicity: Optional
• Default: none
• Description: Specifies which sections the template applies to, with filtering using classes.

Usage

The Sections field specifies which sections the template should be applied to. It can filter within sections using classes.

Example

Specifications:
  Layers:
    - Name: Controllers
      Sections:
        - Classes:
          - ResponseDto

Specifications.Template.Content#

Definition

• DataType: String
• Type: text
• Multiplicity: Required
• Default: none
• Description: Defines the content template. Can be multiline.

Usage

The Content field allows for the definition of a multiline content template.

Notes

• Used to define reusable content templates for common and standard operations.
• Can be imported and used in other templates.

Example

Specifications:
  Template:
    Content: |
      {
        "name": "{{.Resource.Name}}",
        "description": "This is a data template for {{.Resource.Name}}"
      }

Examples#

Type: Template
Kind: File
Name: ResponseDto
Metadata:
Tags:
Specifications:
  Name: ResponseDto
  Output: '{{template "ResourceNameTemplate" .}}.json'
  Set: EShopping
  Layers:
  - Name: Dtos
    Sections:
      - Classes:
        - ResponseDto
  Template:
      Content: |
      {
          "name": "{{.Resource.Name}}",
          "description": "This is a data template for {{.Resource.Name}}"
      }

This document provides detailed information about the File Template model used in Pars. The File Template model is defined with specific fields that help in structuring and managing different file templates. The data field allows for flexible and YAML-compliant data definitions.