interface GetDeprecationsContext {
  esClient: IScopedClusterClient;
  savedObjectsClient: SavedObjectsClientContract;
}

interface DeprecationInfo {
  message: string;
  level: 'warning' | 'critical';
  documentationUrl?: string;
  correctiveActions: {
    api?: {
      path: string;
      method: 'POST' | 'PUT';
      body?: {
        [key: string]: any;
      };
    };
    manualSteps?: string[];
  }; 
}

[
  rename('config.old', 'config.new', {
     silent: true,
     documentationUrl: 'elastic.co/some-url'
  }),
]

export const config: PluginConfigDescriptor<ConfigType> = {
  schema: configSchema,
  deprecations: ({ renameFromRoot }) => [
    renameFromRoot('ui_metric.debug', 'usageCollection.uiCounters.debug'),
  ],
};

{
  "deprecationsInfo":[{
    "level":"critical",
    "message": "\"ui_metric.debug\" is deprecated and has been replaced by \"usageCollection.uiCounters.debug\"",
    "correctiveActions":{
      "manualSteps": [
        "Replace \"ui_metric.debug\" in the kibana.yml file with \"usageCollection.uiCounters.debug\""
        ]
      },
    "domainId":"usageCollection"
  }]
}

export const config: PluginConfigDescriptor<ConfigSchema> = {
  exposeToBrowser: {
    defaultAppId: true,
  },
  schema: configSchema,
  deprecations: () => [
    (
      completeConfig: Record<string, any>,
      rootPath: string,
      addDeprecation: AddConfigDeprecation
    ) => {
      if (
        get(completeConfig, 'kibana.defaultAppId') === undefined &&
        get(completeConfig, 'kibana_legacy.defaultAppId') === undefined
      ) {
        return completeConfig;
      }
      addDeprecation({
        message: `kibana.defaultAppId is deprecated and will be removed in 8.0. Please use the \`defaultRoute\` advanced setting instead`,
        correctiveActions: {
          manualSteps: [
            'Go to Stack Management > Advanced Settings',
            'Update the "defaultRoute" setting under the General section',
            'Remove "kibana.defaultAppId" from the kibana.yml config file',
          ],
        },
      });
      return completeConfig;
    },
  ],
};

interface DeprecationsService {
    getAllDeprecations: (): Promise<PluginDeprecationDetails[]>;
    getDeprecations: (pluginId: string): Promise<PluginDeprecationDetails[]>;
}

{
    "deprecationsInfo": [
        {
            "message": "You have 2 Timelion worksheets. The Timelion app will be removed in 8.0. To continue using your Timelion worksheets, migrate them to a dashboard.",
            "documentationUrl": "https://www.elastic.co/guide/en/kibana/master/dashboard.html#timelion-deprecation",
            "level": "warning",
            "correctiveActions": {
                "manualSteps": [
                    "Navigate to the Kibana Dashboard and click \"Create dashboard\".",
                    "Select Timelion from the \"New Visualization\" window.",
                    "Open a new tab, open the Timelion app, select the chart you want to copy, then copy the chart expression.",
                    "Go to Timelion, paste the chart expression in the Timelion expression field, then click Update.",
                    "In the toolbar, click Save.",
                    "On the Save visualization window, enter the visualization Title, then click Save and return."
                ]
            },
            "domainId": "timelion"
        },
        {
            "message": "User 'test_dashboard_user' is using a deprecated role: 'kibana_user'",
            "correctiveActions": {
                "api": {
                    "path": "/internal/security/users/test_dashboard_user",
                    "method": "POST",
                    "body": {
                        "username": "test_dashboard_user",
                        "roles": [
                            "machine_learning_user",
                            "enrich_user",
                            "kibana_admin"
                        ],
                        "full_name": "Alison Goryachev",
                        "email": "alisongoryachev@gmail.com",
                        "metadata": {},
                        "enabled": true
                    }
                },
                "manualSteps": [
                    "Using Kibana user management, change all users using the kibana_user role to the kibana_admin role.",
                    "Using Kibana role-mapping management, change all role-mappings which assing the kibana_user role to the kibana_admin role."
                ]
            },
            "documentationUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html",
            "level": "critical",
            "domainId": "security"
        },
        {
            "message": "User 'test' is using a deprecated role: 'kibana_dashboard_only_user'",
            "correctiveActions": {
                "manualSteps": [
                    "Using Kibana role management, create a new custom role.",
                    "Assign read-only access to the Dashboard feature.",
                    "Assign this role in place of the dashboard_only role."
                ]
            },
            "documentationUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html",
            "level": "critical",
            "domainId": "security"
        },
        {
            "message": "User 'kibana' has been deprecated.",
            "correctiveActions": {
                "manualSteps": [
                    "Using Kibana user management, set the password for the kibana_system user",
                    "Update all kibana.yml files to use this username and password for elasticsearch.username and elasticsearch.password"
                ]
            },
            "documentationUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html",
            "level": "critical",
            "domainId": "security"
        }
    ]
}