Skip to content

feat: added openapi experimental support docs #2578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidkna-sap merged 3 commits into from
Aug 19, 2026
+24 −1
Merged

feat: added openapi experimental support docs #2578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ff7e95
added openapi experimental support docs
BrigittaK307 Aug 10, 2026
b65d47e
Applied PR comments
BrigittaK307 Aug 18, 2026
dc26646
Merge branch 'main' into I753325-633
BrigittaK307 Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs-js/features/openapi/generate-openapi-client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment thread
davidkna-sap marked this conversation as resolved.

### 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.
Expand Down
2 changes: 1 addition & 1 deletion docs-js/features/openapi/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading