Skip to content

Latest commit

 

History

History
45 lines (44 loc) · 2.76 KB

SCHEMA.md

File metadata and controls

45 lines (44 loc) · 2.76 KB
Raw

Schema for lunar-diamond-engraving

  • baldrick-pest-schema (object): Settings for a lunar-diamond-engraving file
  • ◆ title (string): _
  • ◆ webpage (string): A https link to a webpage
  • ◆ url (string): A https link to the item resource
  • ◆ engravings (object): List of domain for engraving
    • ◇ title (string): A concise title describing the domain
    • ◇ url (string): A https link to the item resource
    • ◇ logger (string): A unique key representing a logger
    • ◇ phases (object): The different phases of engraving the domain
      • ◆ validation (object): _
        • ◆ title (string): What is been validated
        • ◆ keywords (string): A list of custom keywords that can be used as metatadata for documentation
        • ◆ check (object): Main validation that must be satisfied
          • ◆ opts (string): Id for validating the options passed to processing
          • ◆ headers (string): Id for validating the options passed to processing
          • ◆ parameters (string): Id for validating the options passed to processing
          • ◆ payload (string): Id for validating the options passed to processing
          • ◆ context (string): Id for validating the options passed to processing
      • ◆ shield (object): _
        • ◆ title (string): What is been validated
        • ◆ keywords (string): A list of custom keywords that can be used as metatadata for documentation
        • ◆ check (object): Main validation that must be satisfied
          • ◆ opts (string): Id for validating the options passed to processing
          • ◆ headers (string): Id for validating the options passed to processing
          • ◆ parameters (string): Id for validating the options passed to processing
          • ◆ payload (string): Id for validating the options passed to processing
          • ◆ context (string): Id for validating the options passed to processing
      • ◆ actions (object): A list of actions to run
        • ◇ title (string): _
        • ◇ keywords (string): A list of custom keywords that can be used as metatadata for documentation
        • ◇ uses (string): A unique key representing a function
      • ◆ onFinish (object): The final action that will be called when all other actions will have finished
        • ◆ title (string): _
        • ◆ keywords (string): A list of custom keywords that can be used as metatadata for documentation
        • ◆ uses (string): A unique key representing a finish function