file.json

file.json

{
  "actions": [
    {
      "environment_required": false, 
      "long_running_task": false, 
      "name": "deactivate", 
      "nicknames": [
        "disable", 
        "inactive"
      ], 
      "resources": {
        "dockerhub/updates": {
          "action": "deactivate", 
          "api_path": "/deactivate/dockerhub/updates/", 
          "args": {
            "environments": {
              "can_single_suggestion": true, 
              "description": "environment name, can be a single element or list", 
              "options": [
                "development"
              ], 
              "required": true, 
              "type": "list"
            }
          }, 
          "ask_for_confirmation": false, 
          "bot_examples": [
            "can you disable the dockerhub updates? on production", 
            "make inactive auto deploys on test environment", 
            "deactivate dockerhooks automatic? environments=`all`", 
            "i want disable automatic updates from dockerhub. on development"
          ], 
          "description": "Deactivate automatic updates from dockerhub", 
          "further_doc_link": null, 
          "is_environment_required": true, 
          "long_running_task": false, 
          "methods": [
            "POST"
          ], 
          "name": "updates", 
          "nicknames": [
            "deploy", 
            "webhooks", 
            "hook"
          ], 
          "nicknames_parent": [
            "automatic"
          ], 
          "parent": "dockerhub"
        }
      }
    }, 
    {
      "environment_required": false, 
      "long_running_task": false, 
      "name": "activate", 
      "nicknames": [
        "enable", 
        "active"
      ], 
      "resources": {
        "dockerhub/updates": {
          "action": "activate", 
          "api_path": "/activate/dockerhub/updates/", 
          "args": {
            "environments": {
              "can_single_suggestion": true, 
              "description": "environment name, can be a single element or list", 
              "options": [
                "development"
              ], 
              "required": true, 
              "type": "list"
            }
          }, 
          "ask_for_confirmation": false, 
          "bot_examples": [
            "can you activate the dockerhub updates? environments=`production`", 
            "enable auto deploys prod and dev", 
            "can you make the webhooks automatic active? environments=`stage,production`", 
            "i want enable automatic updates from dockerhub. on stage"
          ], 
          "description": "Activate automatic updates from dockerhub on environment", 
          "further_doc_link": null, 
          "is_environment_required": true, 
          "long_running_task": false, 
          "methods": [
            "POST"
          ], 
          "name": "updates", 
          "nicknames": [
            "deploy", 
            "webhooks", 
            "hook"
          ], 
          "nicknames_parent": [
            "automatic"
          ], 
          "parent": "dockerhub"
        }
      }
    }, 
    {
      "environment_required": false, 
      "long_running_task": false, 
      "name": "deploy", 
      "nicknames": [
        "update"
      ], 
      "resources": {
        "default": {
          "action": "deploy", 
          "api_path": "/deploy/", 
          "args": {
            "environments": {
              "can_single_suggestion": true, 
              "description": "environment name, can be a single element or list", 
              "options": [
                "development"
              ], 
              "required": true, 
              "type": "list"
            }, 
            "roles": {
              "default": [
                "sageaxcess"
              ], 
              "description": "list of roles to deploy, if this field is missing all and only the aegis services will be updated", 
              "options": [
                "grafana", 
                "kafka", 
                "mongodb", 
                "postgres", 
                "rabbitmq", 
                "redshift", 
                "sageaxcess", 
                "zookeeper", 
                "sageaxcess/router", 
                "sageaxcess/user-account", 
                "sageaxcess/guest", 
                "sageaxcess/api-key", 
                "sageaxcess/client", 
                "sageaxcess/expressions", 
                "sageaxcess/ui-metrics", 
                "sageaxcess/ip-user-map", 
                "sageaxcess/report", 
                "sageaxcess/mail-worker", 
                "sageaxcess/sageaxcess-web", 
                "sageaxcess/visualization-data-service", 
                "sageaxcess/public_proxy", 
                "sageaxcess/data-receiver", 
                "prometheus", 
                "consul/save_settings"
              ], 
              "required": false, 
              "single_suggestion": true, 
              "type": "list"
            }
          }, 
          "ask_for_confirmation": true, 
          "bot_examples": [
            "dev update", 
            "deploy productions", 
            "update `environments=all`", 
            "on dev can you make an update now? only `image=sageaxcess/sageaxcess-web,sageaxcess/api-key`"
          ], 
          "description": "Update the docker containers on `environment`, this command don't modify the infrastructure", 
          "further_doc_link": null, 
          "is_environment_required": true, 
          "long_running_task": true, 
          "methods": [
            "POST"
          ], 
          "name": "default", 
          "nicknames": [], 
          "nicknames_parent": [], 
          "parent": null
        }
      }
    }
  ]
}