Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.1 and Openapi v3 updates #5

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

madaster97
Copy link

@madaster97 madaster97 commented Jan 13, 2021

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

madaster97 and others added 7 commits December 29, 2020 20:44
Begin porting openapi spec to v1.1 of CDS Hooks. Mainly updated descriptions and examples to match the [current draft](https://cds-hooks.org/specification/current/#fhir-resource-access) as of January 9th 2020
Added descriptions, enums, and new fields to CdsResponse schemas
Added feedback schema + endpoint. Edited discovery endpoint to include authorization req.
@isaacvetter
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants