From b3850d733df391ffeb05684d827054e881db933d Mon Sep 17 00:00:00 2001 From: Reuven Date: Tue, 6 Feb 2024 21:28:59 +0200 Subject: [PATCH] update readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index bc068f4b..56b6b852 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ docker run --rm -t tufin/oasdiff changelog https://raw.githubusercontent.com/Tuf - [Multiple versions of the same endpoint](MATCHING-ENDPOINTS.md) - [Merge allOf schemas](ALLOF.md) - [Merge common parameters](COMMON-PARAMS.md) +- [Case-insensitive header comparison](#case-insensitive-header-comparison) - [Path prefix modification](#path-prefix-modification) - [Path parameter renaming](#path-parameter-renaming) - [Excluding certain kinds of changes](#excluding-specific-kinds-of-changes) @@ -241,6 +242,13 @@ Sometimes developers decide to change names of path parameters, for example, in Oasdiff supports path parameter renaming by default. [Learn more](MATCHING-ENDPOINTS.md) about how oasdiff supports path parameter renaming. +## Case-Insensitive Header Comparison +Header names comparison is normally case-sensitive. +To make this comparison case-insensitive, add the `--case-insensitive-headers` flag: +``` +oasdiff diff data/header-case/base.yaml data/header-case/revision.yaml --case-insensitive-headers +``` + ## Excluding Specific Kinds of Changes You can use the `--exclude-elements` flag to exclude certain kinds of changes: - Use `--exclude-elements examples` to exclude [Examples](https://swagger.io/specification/#example-object)