feat: add support for OpenAPI 3.1 (#32300)

* breaking: add support for OpenAPI 3.1

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* add changeset

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* update nullable prop

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* remove more allowReserved usages

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* make changes less breaking

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* Apply suggestion from @aramissennyeydd

Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>

packages/backend-openapi-utils/README.md

@@ -4,6 +4,8 @@
 
 This package is meant to provide a typed Express router for an OpenAPI spec. Based on the [`oatx`](https://github.com/varanauskas/oatx) library and adapted to override Express values.
 
+Only supports OpenAPI 3.1 specifications.
+
 ## Getting Started
 
 ### Configuration

packages/backend-openapi-utils/src/stub.ts

@@ -54,6 +54,7 @@ export function getOpenApiSpecRoute(baseUrl: string) {
 /**
  * Create a router with validation middleware. This is used by typing methods to create an
  *  "OpenAPI router" with all of the expected validation + metadata.
+ * Only supports OpenAPI 3.1 specifications.
  * @param spec - Your OpenAPI spec imported as a JSON object.
  * @param validatorOptions - `openapi-express-validator` options to override the defaults.
  * @returns A new express router with validation middleware.
@@ -115,6 +116,7 @@ function createRouterWithValidation(
 
 /**
  * Create a new OpenAPI router with some default middleware.
+ * Only supports OpenAPI 3.1 specifications.
  * @param spec - Your OpenAPI spec imported as a JSON object.
  * @param validatorOptions - `openapi-express-validator` options to override the defaults.
  * @returns A new express router with validation middleware.
@@ -132,6 +134,7 @@ export function createValidatedOpenApiRouter<T extends RequiredDoc>(
 
 /**
  * Create a new OpenAPI router with some default middleware.
+ * Only supports OpenAPI 3.1 specifications.
  * @param spec - Your OpenAPI spec imported as a JSON object.
  * @param validatorOptions - `openapi-express-validator` options to override the defaults.
  * @returns A new express router with validation middleware.