Skip to content

Commit 2959c2a

Browse files
authored
Explain why the Open API Specification is supported (fixes #346) (#370)
1 parent 28965d7 commit 2959c2a

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/specification/1.0.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@ This specification has the following limitations.
1717
* The specification requires that each CDS Service provider be registered (client_id, key-pair identifier) with the EHR Authorization Server, but does not dictate how registration is accomplished (e.g., dynamic vs. manual).
1818
* The specification acknowledges that each EHR vendor/provider will need to vet CDS Service providers and suggests that vendors/providers may want to create a "white list" of providers deemed "safe" and/or a "black list" of providers deemed "unsafe." Similarly, an EHR vendor/provider may choose to assess the safety of active links embedded in CDS Hooks Cards returned to the EHR. The specification does not suggest how such vetting is accomplished nor suggest factors to consider, as these judgments are dependent upon each EHR vendor's or provider's existing vetting processes and risk-management policy.
1919

20-
## Swagger (Open API Specification)
20+
## Open API Specification
2121

22-
The CDS Hooks specification is available as an Open API Specification using Swagger. You can download the [API specification](/specification/1.0-api.yaml) and view it online via the [Swagger Editor](http://editor.swagger.io/?url=https://raw.githubusercontent.com/cds-hooks/docs/master/docs/specification/1.0-api.yaml).
22+
An [Open API Specification](https://www.openapis.org/) (formally known as the Swagger Specification) interface of CDS Hooks is available. The open source Open API Specification defines a programming language-agnostic method to describe a RESTful API like CDS Hooks. The Open API Specification is used by many projects and is supported by CDS Hooks for the benefit of implementers.
23+
24+
CDS Hooks implementers are not required to use the Open API Specification interface of CDS Hooks. You can download the [API specification](/specification/1.0-api.yaml) and view it online via the [Swagger Editor](http://editor.swagger.io/?url=https://raw.githubusercontent.com/cds-hooks/docs/master/docs/specification/1.0-api.yaml).
2325

2426
## Discovery
2527

0 commit comments

Comments
 (0)