spike: OpenAPI 3 Upgrade

[plittlewood-rpt]

Background context To allow us to better provide examples to developers we should spec out a route to update our Swagger documentation to OpenAPI3. The biggest issue we have is with the introduction of the notifications API which is going to support different models based on the data being submitted.

We have previously looked at this as part of the shared entities project, and from memory the Swagger package has been updated already to support the new version.

Specification

• Project: Reapit.Packages.Swagger

  • Confirm this package is already geared up for OpenAPI3
  • Using two services, review the differences between the swagger output and ensure the documentation from each service renders correctly in isolation

• Project: Reapit.Lambdas.SwaggerMerge

  • Ensure the swagger merge tool can cope with OpenAPI3 using the output from the two services above

• Other considerations

  • Consider if there is any downstream impact to developers by making this change, this will determine whether or not we need to communicate the change. Work with HP on any comms piece

At the end of this work we should be comfortable of how we can move to Open API 3 for our public APIs. We will need to update all our services at the same time so that the swagger merge mechanism still continues to function. Ideally, if we can do this with a package update and a few lines of code change, this will make the sweep ticket easier to complete.

[HollyJoyPhillips]

Internal reference: PBI-5711