docuementation

Tufin · Jul 2, 2023 · 9851dd6 · 9851dd6
1 parent 5cdd72c
commit 9851dd6
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/API-DEPRECATION.md b/API-DEPRECATION.md
@@ -15,10 +15,10 @@ oasdiff allows you to gracefully remove a resource without getting the ```breaki
    ```
 2. At the sunset date or anytime later, the resource can be removed without triggering a ```breaking-change``` warning. An earlier removal will be considered a breaking change.
 
-In addition, oasdiff also allows you to control the minimal number of days required between deprecating a resource and removing it with the ```deprecation-days``` flag.  
+In addition, oasdiff also allows you to control the minimal number of days required between deprecating a resource and removing it with the ```--deprecation-days``` flag.  
 For example, the following command requires any deprecation to be accompanied by an ```x-sunset``` extension with a date which is at least 30 days away, otherwise the deprecation itself will be considered a breaking change:
 ```
-oasdiff -deprecation-days=30 -breaking-only -base data/deprecation/base.yaml -revision data/deprecation/deprecated-past.yaml
+oasdiff breaking data/deprecation/base.yaml data/deprecation/deprecated-past.yaml --deprecation-days=30 
 ```
 
 Setting deprecation-days to 0 is equivalent to the default which allows non-breaking deprecation regardless of the sunset date.  

diff --git a/BREAKING-CHANGES.md b/BREAKING-CHANGES.md
@@ -67,7 +67,7 @@ If you don't use the `x-extensible-enum` in your OpenAPI specifications, nothing
 OASDiff allows you to [deprecate APIs gracefully](API-DEPRECATION.md) without triggering a breaking-change error.
 
 ### Optional Breaking-Changes Checks
-You can use the `-include-checks` flag to include the following optional checks:
+You can use the `--include-checks` flag to include the following optional checks:
 - response-non-success-status-removed
 - api-operation-id-removed
 - api-tag-removed

diff --git a/README.md b/README.md
@@ -210,7 +210,7 @@ Some YAML libraries don't support complex mapping keys:
 - python PyYAML: see https://github.com/Tufin/oasdiff/issues/94#issuecomment-1087468450
 - golang gopkg.in/yaml.v3 fails to unmarshal the oasdiff output. This package offers a solution: https://github.com/tliron/yamlkeys
 
-In such cases, consider using `-exclude-elements endpoints` and `-format json` as a workaround.
+When using output format `json`, oasdiff excludes `endpoints` automatically.
 
 ## Composed Mode
 Composed mode compares two collections of OpenAPI specs instead of a pair of specs in the default mode.