Metadata

Metadata (info) provides core descriptive information for test scripts, helping users quickly understand the script's purpose while facilitating automated processing by tools.

Basic Information Fields

Complete description of the script:

Field Name	Type	Required	Length	Description
name	string	No	≤200	Script identifier name
description	string	No	≤800	Detailed description of script functionality
version	string	No	≤40	Script version number
termsOfService	string	No	≤400	URL of terms of service
contact	object	No	-	Contact information object
license	object	No	-	License information object

💡 Extension Tip: All metadata fields can be extended through the standardized "extension fields" mechanism

A complete metadata configuration example:

info:
  name: "Example Script Name"
  description: "Example script functionality description"
  version: "1.0.0"
  termsOfService: "https://example.com/terms"
  contact: # Contact information
    name: "Technical Support Team"
    url: "https://example.com/contact"
    email: "support@example.com"
  license: # License information
    name: "MIT License"
    url: "https://opensource.org/licenses/MIT"

Contact Information (contact)

Maintainer contact channels for the script

Field Name	Type	Required	Length	Description
name	string	No	≤200	Contact person/team name
url	string	No	≤400	Contact information page URL
email	string	No	≤160	Contact email address

contact:
  name: "Technical Support Team"
  url: "https://example.com/contact"
  email: "support@example.com"

License Information (license)

Usage authorization information for the script

Field Name	Type	Required	Length	Description
name	string	No	≤200	License name
url	string	No	≤400	License details URL

license:
  name: "MIT License"
  url: "https://opensource.org/licenses/MIT"