Overview

Openapi v3 Document

Currently, there is an Openapi v2 document available for CDS Hooks.

In this PR, I've added on Openapi v3 document that can potentially replace the existing v2 document.

As part of this addition, I added/changed the following:

• Added security schemes to better document how to trust CDS Clients and where (all endpoints)
• Renamed some models to have no spaces in the name. Ex: CDS Service is now PascalCase CdsService.
  • We'd be justified in doing this for the v2 document as well. See issue I found with a swagger parser over this.

CDS Hooks v1.1 Updates

In the Openapi v3 document, I also added/updated items per the current CDS Hooks spec.

• Updated descriptions to match the docs in markdown
• Added schemas/paths for the feedback endpoints
• Other edits such as
  • selectionBehavior changes
  • isRecommend addition

Feedback from @fil512, why doesn't the swagger docs also define the individual hooks?