Uploaded image for project: 'CFEngine Community'
  1. CFEngine Community
  2. CFE-1869

please include description of each element in the syntax description dump

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: Medium
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: cf-promises
    • Labels:
    • Story Points:
      3

      Description

      Hello,

      Could you please include a description of each element in the syntax description dump? That would make the syntax description dump 100x more useful. (It's already great, I'm just saying it'll be much more useful.)

      For example, here is an attribute name and description:

      select_class Select one of the named list of classes to define based on host identity

      And here is the syntax description dump JSON which is missing the description:

              "select_class": {
                "attribute": "select_class",
                "status": "normal",
                "type": "clist",
                "range": "[a-zA-Z0-9_!&@@$|.()\\[\\]{}:]+",
                "visibility": "promiseType"
              },
      

      Here is what is requested:

              "select_class": {
                "attribute": "select_class",
                "description": "Select one of the named list of classes to define based on host identity",
                "status": "normal",
                "type": "clist",
                "range": "[a-zA-Z0-9_!&@@$|.()\\[\\]{}:]+",
                "visibility": "promiseType"
              },
      

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              vpodzime Vratislav Podzimek
              Reporter:
              atsaloli Aleksey Tsalolikhin
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated: