Commit 301f8677 authored by Clement Bois's avatar Clement Bois
Browse files

Merge branch 'docs/add-example-globalvar' into 'main' 

docs: add example and has_default fields

See merge request to-be-continuous/kicker!496
parents 6ea6b843 14feb1ca

kicker-extras-schema-1.json

+9 −0
Original line number Diff line number Diff line
@@ -108,6 +108,10 @@ 
          "description": "The variable default value",

          "type": "string"

        },

        "example": {

          "description": "The variable example value when default is not explanatory enough.",

          "type": "string"

        },

        "advanced": {

          "description": "Whether the variable is advanced usage (default is 'false')",

          "default": false,
@@ -122,6 +126,11 @@ 
          "description": "Whether setting the variable is mandatory to use the template or the feature",

          "default": false,

          "type": "boolean"

        },

        "has_default": {

          "description": "Whether the variable has a matching TBC_DEFAULT_ global variable (default is 'false').",

          "default": false,

          "type": "boolean"

        }

      }

    },

kicker-schema-1.json

+9 −0
Original line number Diff line number Diff line
@@ -115,6 +115,10 @@ 
          "description": "The variable default value.",

          "type": "string"

        },

        "example": {

          "description": "The variable example value when default is not explanatory enough.",

          "type": "string"

        },

        "advanced": {

          "description": "Whether the variable is advanced usage (default is 'false').",

          "default": false,
@@ -129,6 +133,11 @@ 
          "description": "Whether setting the variable is mandatory to use the template or the feature.",

          "default": false,

          "type": "boolean"

        },

        "has_default": {

          "description": "Whether the variable has a matching TBC_DEFAULT_ global variable (default is 'false').",

          "default": false,

          "type": "boolean"

        }

      }

    },