diff --git a/API.md b/API.md index 2731fa3..e8210c4 100644 --- a/API.md +++ b/API.md @@ -1,4 +1,4 @@ -# cpp-oasvalidator v1.0.0: API Reference +# cpp-oasvalidator v1.1.0: API Reference `cpp-oasvalidator` offers a comprehensive API for validating HTTP requests in accordance with OpenAPI specifications. It encompasses various validation categories including *Path, Body, Parameters, and Response*. The API functions return a `ValidationError` type and accept a reference to a `std::string` for populating error messages in case of validation failure. A successful validation returns `ValidationError::NONE`. Otherwise, an error code is returned and the error message is populated. The error message follows this JSON schema: @@ -43,7 +43,7 @@ Four overloaded methods are available to validate different combinations of requ The following API reference outlines each function and its sequence of validation checks. ## Table of Contents -1. [Constructor](#1-constructor) +1. [Constructor](#1-constructor-) 2. [Validate Route](#2-validate-route-) 3. [Validate Body](#3-validate-body-) 4. [Validate Path Parameters](#4-validate-path-parameters-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 166f38f..9ca2a4d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.10 FATAL_ERROR) # Version and other settings set(OASVALIDATOR_VERSION_MAJOR "1") -set(OASVALIDATOR_VERSION_MINOR "0") +set(OASVALIDATOR_VERSION_MINOR "1") set(OASVALIDATOR_VERSION_PATCH "0") set(OASVALIDATOR_VERSION_STRING "${OASVALIDATOR_VERSION_MAJOR}.${OASVALIDATOR_VERSION_MINOR}.${OASVALIDATOR_VERSION_PATCH}") set(OASVALIDATOR_SUMMARY "C++ library") diff --git a/README.md b/README.md index fdb14fd..1e9fde1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ cpp-oasvalidator: REST Request Validator ![Win build](https://img.shields.io/github/actions/workflow/status/nawaz1991/cpp-oasvalidator/windows-build.yml?logo=windows&label=Tests) [![codecov](https://codecov.io/gh/nawaz1991/cpp-oasvalidator/branch/main/graph/badge.svg?token=96b475c2-8dc1-4693-8ce3-84a572720d43)](https://codecov.io/gh/nawaz1991/cpp-oasvalidator) [![License](https://img.shields.io/github/license/nawaz1991/cpp-oasvalidator.svg)](./LICENSE) -[![API Docs](https://img.shields.io/badge/API%20Docs-v1.0.0-brightgreen)](API.md) +[![API Docs](https://img.shields.io/badge/API%20Docs-v1.1.0-brightgreen)](API.md) [![Benchmark](https://img.shields.io/badge/Benchmark-brightgreen)](https://nawaz1991.github.io/cpp-oasvalidator/benchmark.html)