You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
__openapi-schema-diff__ is a javascript library that compares two OpenAPI schemas and finds breaking changes.
4
8
5
9
-[Installation](#installation)
@@ -13,7 +17,7 @@ __openapi-schema-diff__ is a javascript library that compares two OpenAPI schema
13
17
## Installation
14
18
15
19
```bash
16
-
npm install openapi-schema-diff
20
+
npm i openapi-schema-diff
17
21
```
18
22
19
23
<aname="usage"></a>
@@ -198,9 +202,9 @@ Compares two OpenAPI schemas and returns and finds breaking changes. Source and
198
202
-`sourceSchema`__\<object\>__ - source OpenAPI schema of the component.
199
203
-`targetSchema`__\<object\>__ - target OpenAPI schema of the component.
200
204
-`comment`__\<string\>__ - a comment describing the change.
201
-
-`changes`__\<array\>__ - a list of changes in a component json schema. Exist only if `action` equals to `changed`. Each schema keyword has it's own change object. See [list of change objects](#list-schema-keywords-and-their-change-objects).
205
+
-`changes`__\<array\>__ - a list of changes in a component json schema. Exist only if `action` equals to `changed`. Each schema keyword has its own change object. See [list of change objects](#list-schema-keywords-and-their-change-objects).
202
206
203
-
Each of the route components has it's own unique properties that identify it. For more details look at the component change object: [parameter](#parameter-change-object), [request body](#request-body-change-object), [response body](#response-body-change-object), [response header](#response-header-change-object).
207
+
Each of the route components has its own unique properties that identify it. For more details look at the component change object: [parameter](#parameter-change-object), [request body](#request-body-change-object), [response body](#response-body-change-object), [response header](#response-header-change-object).
204
208
205
209
##### Parameter change object
206
210
@@ -258,4 +262,4 @@ Each of the route components has it's own unique properties that identify it. Fo
0 commit comments