diff options
| author | Keith Wall <kwall@apache.org> | 2013-08-05 12:13:32 +0000 |
|---|---|---|
| committer | Keith Wall <kwall@apache.org> | 2013-08-05 12:13:32 +0000 |
| commit | fb1a4d4e3fff65179f1dbcd3fc25b127320380ba (patch) | |
| tree | c1419324dc061307eaa6b0375169fe19cf3e9c54 | |
| parent | 43c9514c20881598736ad26b09c5102cadb01ff3 (diff) | |
| download | qpid-python-fb1a4d4e3fff65179f1dbcd3fc25b127320380ba.tar.gz | |
NO-JIRA: [Java Broker Documentation] Correct forms of REST service urls for message and message-content services.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@1510441 13f79535-47bb-0310-9956-ffa450edef68
| -rw-r--r-- | doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml b/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml index 1178b987ff..7ec2428414 100644 --- a/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml +++ b/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml @@ -119,7 +119,7 @@ <row> <entry> <para>/rest/queue</para> - <para>/rest/queue/<virtual host name>/>queue name></para> + <para>/rest/queue/<virtual host name>/<queue name></para> </entry> <entry>Rest service to manage queue(s)</entry> <entry>Retrieves the details about the queue(s)</entry> @@ -173,7 +173,7 @@ </row> <row> <entry> - <para>/rest/message/*</para> + <para>/rest/message/<virtual host name>/<queue name></para> </entry> <entry>Rest service to manage messages(s)</entry> <entry>Retrieves the details about the messages(s)</entry> @@ -183,7 +183,7 @@ </row> <row> <entry> - <para>/rest/message-content/*</para> + <para>/rest/message-content/<virtual host name>/<queue name></para> </entry> <entry>Rest service to retrieve message content</entry> <entry>Retrieves the message content</entry> @@ -275,22 +275,22 @@ all bindings for all queues for the given exchange in the virtual host. </para> <example> - <title>Examples of queue creation using curl:</title> + <title>Examples of queue creation using curl (authenticating as user admin):</title> <programlisting><![CDATA[ #create a durable queue -curl -X PUT -d '{"durable":true}' http://localhost:8080/rest/queue/<vhostname>/<queuename> +curl --user admin -X PUT -d '{"durable":true}' http://localhost:8080/rest/queue/<vhostname>/<queuename> #create a durable priority queue -curl -X PUT -d '{"durable":true,"type":"priority"}' http://localhost:8080/rest/queue/<vhostname>/<queuename> +curl --user admin -X PUT -d '{"durable":true,"type":"priority"}' http://localhost:8080/rest/queue/<vhostname>/<queuename> ]]></programlisting> </example><example> <title>Example of binding a queue to an exchange using curl</title> <programlisting><![CDATA[ -curl -X PUT -d '{}' http://localhost:8080/rest/binding/<vhostname>/<exchangename>/<queue-name>/<binding-name> +curl --user admin -X PUT -d '{}' http://localhost:8080/rest/binding/<vhostname>/<exchangename>/<queue-name>/<binding-name> ]]></programlisting> </example> <para> - NOTE: the above examples were performed after editing the - <link linkend="Java-Broker-Configuring-And-Managing-HTTP-Management-Plugin-Configuration">HTTP Management Plugin Configuration</link> - to enable HTTP Basic Authentication on connections not using SSL (i.e HTTPS). + NOTE: These curl examples utilise unsecure HTTP transport. To use the examples it is first necessary enable Basic + authentication for HTTP within the HTTP Management Configuration (it is off by default). + For details see <xref linkend="Java-Broker-Configuring-And-Managing-HTTP-Management-Plugin-Configuration"/> </para> </section> |