BlogBlogA post on somebody's own site or a community platform. Nobody edits it after publication, so it dates from the day it was written.See every one →SAP CommunityPart 3 of 3
Part 3 – Empowering SAP BTP CAP Services through Open API Spec and Annotations for Effective Communication, Collaboration and Governance
The closing part of a three-post series applies OData @Capabilities annotations — TopSupported, SkipSupported, CountRestrictions, UpdateRestrictions, DeleteRestrictions, FilterRestrictions, SelectSupport, SortRestrictions, SearchRestrictions, InsertRestrictions, ReadRestrictions and NavigationRestrictions — to three sample CDS entities (Purchase Order, Business Partner, Product) and shows the generated OpenAPIOpenAPIHanding a description of the service to clients and tools — an API portal, a code generator, a partner who wants a contract before they write anything.SAP and community, narrow by design document changing with each one. The point it builds toward: the spec is a direct readout of the model and its annotations, not something edited by hand afterward.
Where it sits
Explains
OpenAPIOpenAPIHanding a description of the service to clients and tools — an API portal, a code generator, a partner who wants a contract before they write anything.
Source
reachable
Who is behind it
mohit_bansal3author
In this series
- 1
- 2
- 3Part 3 – Empowering SAP BTP CAP Services through Open API Spec and Annotations for Effective Communication, Collaboration and Governanceyou are here
Properties
About this work
Group by14 of 14 pieces
Piece, what it offersStill applies
From SEO to MEO: Designing Joule-Ready API Layers for SAP Commerce CloudFrom SEO to MEO: Designing Joule-Ready API Layers for SAP Commerce CloudProposes 'Machine Experience Optimization' (MEO), the author's own term and explicitly not an SAP one, for a governed intent facade in front of SAP Commerce Cloud's OCC APIs so an assistant or a SAP Joule skill gets small, business-oriented operations instead of raw endpoints. Works through a full OpenAPI 3.0.3 contract for a product-search intent, with explicit read/write separation, a short-lived confirmation step and an idempotency key for the consequential 'place order' operation, and authorization checked against account and base-site boundaries rather than at the URL alone. The facade still delegates to Commerce's own services, facades and validation; it does not replace or bypass them.BhardwajAditya, published 2026-09-15
No-Code MCP Servers with SAP Integration Suite: From REST API to AI AgentNo-Code MCP Servers with SAP Integration Suite: From REST API to AI AgentWalks through turning a deployed API artifact into a no-code MCP server in SAP Integration Suite's MCP Gateway: the API artifact's OpenAPI spec must be version 3.0.0-3.0.3, since Swagger 2.0 is rejected, and its backend is reached through a BTP Destination using OAuth2ClientCredentials so the agent calling the server never sees the backend secret. The API artifact's own Authorization policy sets an OAuth scope and Trust Upstream MCP Authorization, and the gotcha list traces a 403 on a valid token to that policy rather than to authentication, before the finished MCP server is published through Developer Hub and connected to Claude Code.eddiedu, published 2026-09-15
Building and Consuming an MCP Server in SAP Integration Suite - Connecting it to Claude and JouleBuilding and Consuming an MCP Server in SAP Integration Suite - Connecting it to Claude and JouleA hands-on walkthrough of building a native MCP server artifact on SAP Integration Suite's Integration Cell runtime: an API artifact built from an OpenAPI 3.0 specification (the author converted the SAP Business Accelerator Hub's Swagger 2.0 OData spec) through API Management policies, with the MCP artifact's own Authorization policy set to the api.invoke scope for Developer Hub credentials or a custom role such as ESBMessaging.send for BTP OAuth credentials. The same server is then wired to Claude as a custom connector over an OAuth redirect, and to a Joule Studio agent through BTP destinations carrying the sap.mcp.tools.enabled property, with three worked agents (CPI monitoring, a SuccessFactors testing flow, IDoc reprocessing) run from both.Padmanathan_Vijayan, published 2026-09-11
Integration Suite: Building an MCP Server for a SAP CI Monitoring AssistantIntegration Suite: Building an MCP Server for a SAP CI Monitoring AssistantA step-by-step walkthrough of building an MCP Server artifact on SAP Integration Suite's Integration Cell runtime that wraps the Cloud Integration OData Message Processing Logs API, so a client such as Claude Desktop or VS Code can query failed interfaces in natural language instead of clicking through Monitor. It covers importing an OpenAPI 3.0 specification so each operationId becomes a discoverable tool, selecting tools/resources/prompts, and wiring two separate OAuth service keys — one read-only credential the HTTPS adapter uses against the monitoring API, another the MCP client uses to reach the deployed endpoint. The server is deliberately read-only and ships with no rate limiting or audit logging, which the author flags as missing before any write operation or production use.Daggolu_PremSai, published 2026-07-17
SAP Job Scheduling Service: 🔧 Generate Your Own Client Library from OpenAPI SpecSAP Job Scheduling Service: 🔧 Generate Your Own Client Library from OpenAPI SpecA tutorial on generating a type-safe client library for the SAP Job Scheduling service's REST API from its OpenAPI specification, using the OpenAPI Generator CLI to target Node.js, TypeScript, Java, Python, Go or C#. It walks through OAuth 2.0 client-credentials authentication and the generated client's Jobs API, listing, creating and reading jobs with their cron schedules, and lists what the service's error statuses (400, 401, 404, 409, 429, 503) mean to a caller. It states that the official @sap/jobs-client will be deprecated and tells readers to use a generated client for now.DenisDuev, published 2026-05-04
Use REST services in GraphUse REST services in GraphSAP Graph turns a REST service into a business data graph by pairing a data destination with a metadata destination that supplies its OpenAPI document, since plain REST has no $metadata endpoint of the kind OData exposes. It walks through creating both destinations on SAP BTP, including the OAuth2ClientCredentials authentication needed when the OpenAPI file is hosted through an API artifact, and shows how Graph flattens each REST operation's path and method into an unbound OData action or function, such as turning a DELETE on /users/pets into a POST to users_pets__delete.florian_moritz, published 2026-01-20
Making the Case for Enhanced REST Adapter in SAP Integration SuiteMaking the Case for Enhanced REST Adapter in SAP Integration SuiteCatalogues what SAP Integration Suite's native HTTP adapter supports for authentication (Basic, OAuth 2.0 client credentials and client certificates on the sender; OAuth 2.0 client credentials and SAML bearer assertion on the receiver) and for error handling (retry on HTTP failure only, with no pattern-based retry, failure queues or dead-letter queues), and that it has no OpenAPI import or export. Three worked scenarios, FedEx shipment tracking, Avalara AvaTax and SAP Ariba's operational reporting API, name what that leaves to Groovy scripting: the other OAuth 2.0 flows, gzip and multipart payloads, and pagination that chains a nextPageToken by JSONPath, which is the case the piece makes for the third-party Advantco REST Adapter.peter_ha3, published 2025-07-14
Edge Integration Cell : Design, deploy and manage APIsEdge Integration Cell : Design, deploy and manage APIsWalks through creating an API artifact in API Management on the customer-managed Edge Integration Cell runtime, including the option to generate the artifact by importing an OpenAPI specification rather than from a URL or by hand. It then attaches an Authentication policy and a Quota step capped at four calls per minute, deploys, and shows both the resulting 401 and the quota-breach error in the Monitor logs. The author frames it as the first of a series on Edge Integration Cell's policies.published 2023-11-15
OpenAPIs in the SAP ecosystemOpenAPIs in the SAP ecosystemWhere OpenAPI actually turns up across SAP's own services, from somebody who spends their time in that ecosystem. Orientation rather than implementation.ajmaradiaga, published 2022-10-10
Invoke OpenAPI-documented APIs remotely with SAP Cloud Application Programming ModelInvoke OpenAPI-documented APIs remotely with SAP Cloud Application Programming ModelThe other direction: consuming an API described by an OpenAPI document from CAP, rather than publishing one. Worth pairing with the plugin entries here, which all serve the outbound half.wittro, published 2022-08-30
Invoke OpenAPI-documented APIs remotely with SAP Cloud Application Programming Model
Destinations changed in @sap-cloud-sdk/connectivity 4.0.0, 2025-03-04. Affects Runnable code.
Swagger UI | SAP BTP Extension Generators | Hands-on Video TutorialsSwagger UI | SAP BTP Extension Generators | Hands-on Video TutorialsA blog post wrapped around a video playlist from the SAP HANA Academy — Swagger UI for CDS, added to the BTP extension generator series. The written half is an ingredients list and a table of contents; the substance is in the recordings.dvankempen, published 2021-07-09
SAP Tech Bytes: Adding Service Implementation to an SAP HANA ProjectSAP Tech Bytes: Adding Service Implementation to an SAP HANA ProjectThomas Jung converts an existing SAP HANA-only project into a CAP one, exposing its native tables, views and a calculation view as CAP service entities with @cds.persistence.exists so they get full create, update, delete and read operations without being redefined. He adds OData V2 support through an adapter proxy for callers still expecting XSODATA-shaped responses, and separately turns on CAP's OpenAPI generation with its Swagger UI test tool. A second part rebuilds the same service layer with a standalone Node.js module instead of CAP, for cases that need more control than CAP's REST or OData defaults give.published 2021-05-07
New SAP Cloud Application Programming Model Sample for Many-to-Many Relationships and Fiori AnnotationsNew SAP Cloud Application Programming Model Sample for Many-to-Many Relationships and Fiori AnnotationsIntroduces SAP-samples/cloud-cap-hana-swapi, a CAP sample rebuilding the abandoned Star Wars API as a six-entity data model (Films, People, Planets, Species, Starships, Vehicles) chosen for its many-to-many, bi-directional relationships and its use as a Fiori Draft deep-editing test case. The author used CAP's OpenAPI functionality to generate both the Swagger UI test tool and entity diagrams for the data model, alongside the OData services and Fiori preview UI.published 2020-12-21
Adding a Swagger UI to Your SAP Cloud Application Programming Model / Node.js ServiceAdding a Swagger UI to Your SAP Cloud Application Programming Model / Node.js ServiceThe problem stated from the other side of the wire: a CAP and HANA backend consumed by frontend developers with no SAP background, who said in the first meeting that they could not work from what the service offered. A browsable API page is the answer, and this is the post the Swagger UI plugin indexed here exists to serve.published 2020-01-23
Adding a Swagger UI to Your SAP Cloud Application Programming Model / Node.js Service
cds-swagger-ui-express has been through 11 major lines since this was published, most recently 0.9 (2024-07), 0.10 (2024-10), 0.11 (2026-02). Affects Runnable code.
Details
Graph
Source
Type
blog
Published on
Host
community.sap.com
Discovered via
First seen
History
- Entered the atlasDiscovered via SAP Community · cap-tag.
For your agent
- Ref
content:part-3-empowering-sap-btp-cap-services-through-open-api-spec-and-annotations-for- JSON
- /content/part-3-empowering-sap-btp-cap-services-through-open-api-spec-and-annotations-for.json
- MCP
- Connecting an agent