You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by nf...@apache.org on 2022/11/07 10:29:18 UTC
[camel] branch main updated: CAMEL-18694 - Fix documentation to use new path attribute instead of uri (#8676)
This is an automated email from the ASF dual-hosted git repository.
nfilotto pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 2d38f37c869 CAMEL-18694 - Fix documentation to use new path attribute instead of uri (#8676)
2d38f37c869 is described below
commit 2d38f37c869ef5417f8a1ff63863e5b9e91043f5
Author: Aurélien Pupier <ap...@redhat.com>
AuthorDate: Mon Nov 7 11:29:12 2022 +0100
CAMEL-18694 - Fix documentation to use new path attribute instead of uri (#8676)
for rest configuration
Signed-off-by: Aurélien Pupier <ap...@redhat.com>
Signed-off-by: Aurélien Pupier <ap...@redhat.com>
---
.../docs/modules/eips/pages/pollEnrich-eip.adoc | 2 +-
docs/user-manual/modules/ROOT/pages/rest-dsl.adoc | 28 +++++++++++-----------
...how-do-i-import-rests-from-other-xml-files.adoc | 4 ++--
3 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc
index 4a41fd1e8e5..9180ca8ed9b 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/pollEnrich-eip.adoc
@@ -134,7 +134,7 @@ for example download a file from xref:ROOT:aws2-s3-component.adoc[AWS S3] as the
----
<rest path="/report">
<description>Report REST API</description>
- <get uri="/{id}/payload">
+ <get path="/{id}/payload">
<route id="report-payload-download">
<pollEnrich>
<constant>aws-s3:xavier-dev?amazonS3Client=#s3client&deleteAfterRead=false&fileName=report-file.pdf</constant>
diff --git a/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc b/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc
index cb533ea3ea4..0161e3ac1fc 100644
--- a/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc
+++ b/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc
@@ -72,13 +72,13 @@ The example above can be defined in XML as shown below:
----
<camelContext xmlns="http://camel.apache.org/schema/spring">
<rest path="/say">
- <get uri="/hello">
+ <get path="/hello">
<to uri="direct:hello"/>
</get>
- <get uri="/bye" consumes="application/json">
+ <get path="/bye" consumes="application/json">
<to uri="direct:bye"/>
</get>
- <post uri="/bye">
+ <post path="/bye">
<to uri="mock:update"/>
</post>
</rest>
@@ -117,13 +117,13 @@ And using XML DSL it becomes:
[source,xml]
----
<rest path="/customers/">
- <get uri="/{id}">
+ <get path="/{id}">
<to uri="direct:customerDetail"/>
</get>
- <get uri="/{id}/orders">
+ <get path="/{id}/orders">
<to uri="direct:customerOrders"/>
</get>
- <post uri="/neworder">
+ <post path="/neworder">
<to uri="direct:customerNewOrder"/>
</post>
</rest>
@@ -141,13 +141,13 @@ only. The example above can be defined as:
[source,xml]
----
<rest>
- <get uri="/customers/{id}">
+ <get path="/customers/{id}">
<to uri="direct:customerDetail"/>
</get>
- <get uri="/customers/{id}/orders">
+ <get path="/customers/{id}/orders">
<to uri="direct:customerOrders"/>
</get>
- <post uri="/customers/neworder">
+ <post path="/customers/neworder">
<to uri="direct:customerNewOrder"/>
</post>
</rest>
@@ -214,13 +214,13 @@ And in XML:
<restConfiguration inlineRoutes="true"/>
<rest>
- <get uri="/customers/{id}">
+ <get path="/customers/{id}">
<to uri="direct:customerDetail"/>
</get>
- <get uri="/customers/{id}/orders">
+ <get path="/customers/{id}/orders">
<to uri="direct:customerOrders"/>
</get>
- <post uri="/customers/neworder">
+ <post path="/customers/neworder">
<to uri="direct:customerNewOrder"/>
</post>
</rest>
@@ -375,7 +375,7 @@ And in XML DSL:
[source,xml]
----
-<rest uri="/users/">
+<rest path="/users/">
<post type="UserPojo" outType="CountryPojo">
<to uri="direct:newUser"/>
</post>
@@ -714,7 +714,7 @@ can do as shown below:
[source,xml]
----
<!-- this is a rest GET to view an user by the given id -->
-<get uri="/{id}" outType="org.apache.camel.example.rest.User">
+<get path="/{id}" outType="org.apache.camel.example.rest.User">
<description>Find user by id</description>
<param name="id" type="path" description="The id of the user to get" dataType="int"/>
<to uri="bean:userService?method=getUser(${header.id})"/>
diff --git a/docs/user-manual/modules/faq/pages/how-do-i-import-rests-from-other-xml-files.adoc b/docs/user-manual/modules/faq/pages/how-do-i-import-rests-from-other-xml-files.adoc
index 543c53fc7af..5c7ebe719f3 100644
--- a/docs/user-manual/modules/faq/pages/how-do-i-import-rests-from-other-xml-files.adoc
+++ b/docs/user-manual/modules/faq/pages/how-do-i-import-rests-from-other-xml-files.adoc
@@ -26,7 +26,7 @@ a rest (can have more) as shown:
[source,xml]
----
<restContext id="myCoolRest" xmlns="http://camel.apache.org/schema/spring">
- <rest uri="/say/hello">
+ <rest path="/say/hello">
<get>
<to uri="direct:hello"/>
</get>
@@ -45,7 +45,7 @@ And then inside `<camelContext/>` you can refer to the
<restContextRef ref="myCoolRest"/>
- <rest uri="/say/bye">
+ <rest path="/say/bye">
<get consumes="application/json">
<to uri="direct:bye"/>
</get>