Skip to content

Commit 0c928c2

Browse files
authored
Merge pull request #457 from cds-hooks/issue/remove-openapi-from-spec
Remove the OpenAPI model from the specification (fixes #354).
2 parents 8da48d7 + 1542283 commit 0c928c2

File tree

3 files changed

+5
-220
lines changed

3 files changed

+5
-220
lines changed

docs/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,8 @@ materials (*app link card*). A user sees these cards — one or more of each typ
4040

4141
## Try it!
4242

43-
You can try CDS Hooks in our Sandbox at **[http://sandbox.cds-hooks.org](http://sandbox.cds-hooks.org)**
43+
You can try CDS Hooks in our Sandbox at [http://sandbox.cds-hooks.org](http://sandbox.cds-hooks.org)
44+
45+
An [OpenAPI Specification](https://www.openapis.org/) (formally known as the Swagger Specification) interface of CDS Hooks is available. Using the CDS Hooks OpenAPI specification, you can generate client or server code to help you get started with your implementation. You can download the [API specification](https://github.com/cds-hooks/api) and view it online via the [Swagger Editor](http://editor.swagger.io/?url=https://raw.githubusercontent.com/cds-hooks/api/master/cds-hooks.yaml).
46+
47+
CDS Hooks implementers are not required to use the OpenAPI Specification interface of CDS Hooks.

docs/specification/1.0-api.yaml

Lines changed: 0 additions & 213 deletions
This file was deleted.

docs/specification/1.0.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,6 @@ The CDS Hooks specification describes the RESTful APIs and interactions to integ
1010
### Conformance Language
1111
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this specification are to be interpreted as described in [RFC2119](https://tools.ietf.org/html/rfc2119).
1212

13-
## Open API Specification
14-
15-
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.
16-
17-
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).
18-
1913
## CDS Hooks Anatomy
2014

2115
This specification describes a ["hook"](http://en.wikipedia.org/wiki/Hooking)-based pattern for invoking

0 commit comments

Comments
 (0)