Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

GitBook expands upon Markdown syntax with an interactive OpenAPI viewer. This should be used for all OpenAPI specifications.

The GitBook OpenAPI paragraph type should be used to point to OpenAPI definitions, stored in yaml format in the /api folder of the GitHub repository, using the full url to the yaml file in the correct branch for the release. So, for example in Payments BB, we would see the development pages pointing to https://github.com/GovStackWorkingGroup/bb-payments/raw/main/api/Prepaymentvalidation.yaml and, when published in the 1.0 release, the link is updated to https://github.com/GovStackWorkingGroup/bb-payments/raw/1.0-QA/api/Prepaymentvalidation.yaml

Language

Added content is always in International English

...