API Docs - OctopusSolutionsEngineering/OctopusRecommendationEngine GitHub Wiki

Base URL: https://octolint-h9d4d3bjatbxd6gr.a02.azurefd.net

Run Check

POST /api/octolint

Headers

  • X-Octopus-ApiKey - Octopus API Key (use this or X-Octopus-AccessToken)
  • X-Octopus-AccessToken - Octopus Access Token (use this or X-Octopus-ApiKey)
  • X-Octopus-Url - Octopus URL
  • X_REDIRECTION_REDIRECTIONS - Redirections to be used by https://github.com/OctopusSolutionsEngineering/AzureFunctionRouter
  • X_REDIRECTION_API_KEY - User redirector API key. Must be supplied for the rules in X_REDIRECTION_REDIRECTIONS to be used.

Example Headers

  • X_REDIRECTION_REDIRECTIONS: [{"host":"myinstance.octopus.app", "redirection": "myinstance.ngrok.app"}]

Example Body

{
  "space": "Spaces-282",
  "onlyTests": "OctoLintUnusedVariables"
}

Example Response

The following variables may be unused (note there are edge cases that may use these variables that can't be detected, so double check these before deleting them): 
CloudFormation - Lambda Simple: APIKey