Skip to content

Remove DAST_API_HOST_OVERRIDE and DAST_API_SPECIFICATION variables

For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features

Deprecation Summary

Now that the new DAST API analyzer is the default for DAST API scans, we will be deprecating the variables DAST_API_HOST_OVERRIDE and DAST_API_SPECIFICATION in %15.7 and removing them in %16.0.

Breaking Change

This will be a breaking change for legacy DAST API users.

  • DAST_API_HOST_OVERRIDE will be removed in favor of using the DAST_API_TARGET_URL to automatically override the host in the OpenAPI specification. No action is necessary unless the DAST_API_HOST_OVERRIDE value is different than the DAST_API_TARGET_URL value. If they are different, the value in DAST_API_TARGET_URL will be used.
  • DAST_API_SPECIFICATION will be removed in favor of DAST_API_OPENAPI. To continue using an OpenAPI specification to guide the test, users must replace the DAST_API_SPECIFICATION variable with the DAST_API_OPENAPI variable. The value can remain the same, but the variable name must be replaced.

Affected Topology

This will affect both SaaS and Self-managed users.

Affected Tier

  • Ultimate

Checklists

Labels

  • This issue is labeled deprecation, and with the relevant ~devops::, ~group::, and ~Category: labels.
  • This issue is labeled breaking change if the removal of the deprecated item will be a breaking change.

Timeline

Please add links to the relevant merge requests.

  • As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule: 14.8, 14.9, 14.10, 15.0 – 14.8 is the third milestone preceding the major release):
  • On or before the major milestone: A removal entry has been created so the removal will appear on the removals by milestones page and be announced in the release post.
  • On the major milestone:

Mentions

  • Your stage's stable counterparts have been @mentioned on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager.
    • To see who the stable counterparts are for a product team visit product categories
      • If there is no stable counterpart listed for Sales/CS please mention @timtams
      • If there is no stable counterpart listed for Support please mention @gitlab-com/support/managers
      • If there is no stable counterpart listed for Marketing please mention @cfoster3
  • Your GPM has been @mentioned so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change.

Deprecation Milestone

Planned Removal Milestone

Links

Edited by Derek Ferguson