This is an automated email from the ASF dual-hosted git repository.
diveshdut pushed a commit to branch codex/sync-ai-agent-rest-skills
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git
The following commit(s) were added to
refs/heads/codex/sync-ai-agent-rest-skills by this push:
new 09c58266b Correct REST framework wording in AI agent skills
09c58266b is described below
commit 09c58266b6fba4f86be601fde928d64df03a8694
Author: diveshdut <[email protected]>
AuthorDate: Fri Jul 10 14:35:52 2026 +0530
Correct REST framework wording in AI agent skills
---
ai-agent-skills/manage-api-integration/SKILL.md | 12 ++++++------
ai-agent-skills/manage-rest-api/SKILL.md | 4 ++--
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/ai-agent-skills/manage-api-integration/SKILL.md
b/ai-agent-skills/manage-api-integration/SKILL.md
index 5b325fe90..66e59e57a 100644
--- a/ai-agent-skills/manage-api-integration/SKILL.md
+++ b/ai-agent-skills/manage-api-integration/SKILL.md
@@ -26,15 +26,15 @@ description: Define and integrate REST and SOAP APIs in
OFBiz.
Integration patterns for exposing OFBiz services via REST and SOAP, and
handling JSON responses.
-## REST API (rest-api)
+## REST API (framework REST API support)
-OFBiz uses the `rest-api` plugin (based on Jersey) to declaratively expose
services.
+OFBiz uses framework REST API support to declaratively expose services.
For REST API design/refactoring, wrapper decisions, contract safety, and
PWA/API consumer compatibility, also read the `manage-rest-api` skill. This
skill remains the broader integration guide for REST mechanics, SOAP
integration, and controller JSON responses.
### REST API Definitions
-REST endpoints are defined in `*.rest.xml` files located in the `api/`
directory of an OFBiz component. These files are automatically discovered and
registered by the `rest-api` plugin; no explicit registration in
`ofbiz-component.xml` is required.
+REST endpoints are defined in `*.rest.xml` files located in the `api/`
directory of an OFBiz component. These files are discovered and registered by
the framework REST API support; no explicit registration in
`ofbiz-component.xml` is required.
**Pattern for `*.rest.xml`:**
```xml
@@ -52,7 +52,7 @@ REST endpoints are defined in `*.rest.xml` files located in
the `api/` directory
### Parameter Handling
-Parameter mapping from REST requests to OFBiz services is **implicit**. The
`rest-api` plugin automatically extracts parameters from the request and maps
them to service IN parameters whose names match.
+Parameter mapping from REST requests to OFBiz services is **implicit**. The
framework REST request handler extracts parameters from the request and maps
them to service IN parameters whose names match.
* **Path Parameters:** Extracted from the URI based on placeholders in the
`path` attributes (e.g., `{exampleId}`).
* **Query Parameters:** Extracted from the request URL.
@@ -81,7 +81,7 @@ OFBiz allows services to be exposed as REST APIs directly via
attributes in the
### Pattern:
- **Attributes**: Set `export="true"` and `action="VERB"` (e.g.,
`action="GET"`).
-- **Result**: The service becomes reachable as a REST endpoint (e.g.,
`/rest/public/findProductById` or similar depending on the `rest-api` plugin
configuration).
+- **Result**: The service becomes reachable as a REST endpoint (e.g.,
`/rest/public/findProductById` or similar depending on framework REST
configuration).
```xml
<service name="findProductById" engine="java" auth="true" export="true"
action="GET" ...>
@@ -132,6 +132,6 @@ Use the `soap-engine` or `SOAPClientEngine`.
## Security & Data Mapping
-- **Authentication**: REST API authentication depends on the `rest-api` plugin
configuration and the invoked service security.
+- **Authentication**: REST API authentication depends on the framework REST
configuration and the invoked service security.
- **Permissions**: Every service invoked should have proper
`permission-service` or `check-permission` logic.
- **Data Mapping**: JSON/XML fields must precisely match service IN attributes
for automatic mapping. Use `ServiceUtil.getAndValidateParameters` pattern in
custom Java events if manual mapping is needed.
diff --git a/ai-agent-skills/manage-rest-api/SKILL.md
b/ai-agent-skills/manage-rest-api/SKILL.md
index a7c656cfa..49efd7119 100644
--- a/ai-agent-skills/manage-rest-api/SKILL.md
+++ b/ai-agent-skills/manage-rest-api/SKILL.md
@@ -1,6 +1,6 @@
---
name: manage-rest-api
-description: Design, expose, refactor, and verify OFBiz REST APIs using the
`rest-api` plugin, service engine contracts, native OFBiz services, and
contract-safe wrapper patterns. Use when working with `.rest.xml` files,
REST-exposed services, PWA/API consumers, service export settings, or backend
REST response contracts.
+description: Design, expose, refactor, and verify OFBiz REST APIs using the
framework REST support, service engine contracts, native OFBiz services, and
contract-safe wrapper patterns. Use when working with `.rest.xml` files,
REST-exposed services, PWA/API consumers, service export settings, or backend
REST response contracts.
---
# Skill: Manage REST APIs
@@ -8,7 +8,7 @@ description: Design, expose, refactor, and verify OFBiz REST
APIs using the `res
## Goal
Build OFBiz REST APIs that are thin, service-native, contract-safe, and easy
to upstream into OFBiz.
-Use OFBiz services, service definitions, entity utilities, and `rest-api`
plugin conventions first. Add REST wrapper services only when they adapt a
transport contract, aggregate read data, or preserve compatibility for an
existing consumer.
+Use OFBiz services, service definitions, entity utilities, and framework REST
conventions first. Add REST wrapper services only when they adapt a transport
contract, aggregate read data, or preserve compatibility for an existing
consumer.
For low-level REST XML syntax, direct service export mechanics, SOAP
integration, or controller JSON response patterns, also read the
`manage-api-integration` skill.
