diff --git a/docs-js/features/openapi/generate-openapi-client.mdx b/docs-js/features/openapi/generate-openapi-client.mdx index 87fd00992a4..dd5c379a936 100644 --- a/docs-js/features/openapi/generate-openapi-client.mdx +++ b/docs-js/features/openapi/generate-openapi-client.mdx @@ -215,6 +215,29 @@ With the approach of the SAP Cloud SDK OpenAPI generator this restriction might Given that you have multiple APIs, it can make sense to have the same function names in different APIs, e.g. `MyResource1Api.getAll()` and `MyResource2Api.getAll()`. The purpose of the `x-sap-cloud-sdk-operation-name` is to allow using duplicate names across APIs, while complying with the OpenAPI specification. +## OpenAPI 3.1 Support + +:::caution + +OpenAPI 3.1 support is an experimental feature. +Generated code may not be fully correct in all edge cases. +Report issues in the SAP Cloud SDK [GitHub repository](https://github.com/SAP/cloud-sdk-js/issues/new/choose). + +::: + +The SAP Cloud SDK generator accepts OpenAPI 3.1 specifications. +When you pass an OpenAPI 3.1 document, the generator emits a warning and proceeds with generation. +OpenAPI 2.0 and OpenAPI 3.0.x documents continue to work without any changes. + +### Unsupported OpenAPI 3.1 Features + +The following OpenAPI 3.1 features are intentionally not represented in the generated client: + +- **Webhooks** — top-level `webhooks` are not generated as callable operations. +- **Reusable path items** — `components/pathItems` used as webhook targets are not generated. + +The generator logs a warning when it encounters either of these features in the input document. + ## npm Packages vs. Local clients The SAP Cloud SDK OpenAPI client generator generates TypeScript code. diff --git a/docs-js/features/openapi/overview.mdx b/docs-js/features/openapi/overview.mdx index 3f2dd773e4c..965ed3c4b4b 100644 --- a/docs-js/features/openapi/overview.mdx +++ b/docs-js/features/openapi/overview.mdx @@ -32,7 +32,7 @@ The [OpenAPI code generator](generate-openapi-client.mdx) is a [command line int - destinations - and other abstractions of the SAP Business Technology Platform. -It supports OpenAPI versions **2.0** and **3.0**. +It supports OpenAPI versions **2.0**, **3.0**, and [**3.1** (experimental)](generate-openapi-client.mdx#openapi-31-support). You can use the OpenAPI generator to create a client library for any OpenAPI-based API service available on the [SAP Business Accelerator Hub](https://api.sap.com/) or found elsewhere in the Internet. If you encounter problems with the OpenAPI tooling of the SAP Cloud SDK, use our [support channels](/docs/overview/get-support) to get help.