UNCLASSIFIED - NO CUI

Add automation for opening MRs when the VAT swagger endpoint is updated

This template is ONLY used for enhancement requests. Bug reporting or new feature request issues should use the other template options for issue submission.

Current Behavior

The vat_api swagger file is stored locally for use in the pipeline. It is also available from a VAT endpoint.

Purpose

We should check for VAT deployments, via calling automation, to see if the swagger spec has been updated by the VAT team, and open an MR when it has been updated. This way we can track the changes added and we can discuss with the VAT team if there are changes we need clarified. Additional info on swagger: https://docs.swagger.io/spec.html

Plan

  • Create a new project in ironbank tools named something like Vat-Swagger-Updater
  • Create a script to do the following
    • Pull down the swagger spec from the VAT endpoint (need to get that path)
    • Get the VAT swagger spec file from the pipeline repo
    • Compare them
    • if there is a difference between them
      • Use gitlab api to automatically open MR in ironbank-pipelines repo to update the file to the updated swagger spec
  • Create a .gitlab-ci file to run the script
  • Create a scheduled job to run at least once daily Add to VAT deployment template

Acceptance Criteria

  • MRs are automatically opened when the VAT team updates their swagger spec.
Edited by Kenneth Maguire