[gatein-commits] gatein SVN: r9141 - epp/docs/branches/6.0/Admin_Guide/en-US.
do-not-reply at jboss.org
do-not-reply at jboss.org
Mon Feb 11 23:30:32 EST 2013
Author: rdickens
Date: 2013-02-11 23:30:32 -0500 (Mon, 11 Feb 2013)
New Revision: 9141
Modified:
epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml
Log:
Review and minor editing of chapter 2
Modified: epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml
===================================================================
--- epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml 2013-02-12 03:45:58 UTC (rev 9140)
+++ epp/docs/branches/6.0/Admin_Guide/en-US/chapter-2-REST.xml 2013-02-12 04:30:32 UTC (rev 9141)
@@ -6,7 +6,7 @@
<chapter id="sid-8094332_GateInManagement-REST">
<title>REST</title>
- <para>The management REST component is responsible for mapping restful requests to management requests. It does this by locating the managed resource by mapping the request URL to a management address and then invoking an operation on that managed resource. It defines an entry point for RESTful clients, and exposes the registered managed resources and operations over REST.</para>
+ <para>The management REST component is responsible for mapping RESTful requests to management requests. It does this by locating the managed resource, mapping the request URL to a management address, then invoking an operation on that managed resource. It defines an entry point for RESTful clients, and exposes the registered managed resources and operations over REST.</para>
<section id="sid-8094332_GateInManagement-EntryPoint">
<title>Entry Point</title>
@@ -57,7 +57,7 @@
<section id="sid-8094332_GateInManagement-HTTPMethod">
<title>HTTP Method</title>
- <para>The following table shows which HTTP methods map to operation names.</para>
+ <para>The following table maps HTTP methods to operation names.</para>
<informaltable>
<tgroup cols="2">
<thead>
@@ -150,10 +150,10 @@
<title>Custom operation defined in request parameter</title>
<programlisting>http://localhost:8080/rest/private/managed-components/foo/bar?op=some-custom-operation</programlisting>
</example>
- <para>It's best practice to use the HTTP method to dictate the operation name when it can. However nothing stops a client explicitly setting operation names as request parameters.</para>
+ <para>It's best practice to use the HTTP method to dictate the operation name when it can. However a client can explicitly set operation names as request parameters.</para>
<note>
<title>Note</title>
- <para>The following URL's are equivalent for a GET request:</para>
+ <para>The following URLs are equivalent to a GET request:</para>
<itemizedlist>
<listitem>
<para>
@@ -171,7 +171,7 @@
<section id="sid-8094332_GateInManagement-URLExtension">
<title>URL Extension</title>
- <para>Sometimes it's nice to represent REST resources as files, so two URL extensions have been added to support two common operations: read-config-as-xml and export-resource. By adding the following URL extensions at the end of the URL, you can invoke these two operations.</para>
+ <para>REST resources can be represented as files, so two URL extensions have been added to support two common operations: read-config-as-xml and export-resource. By adding the following URL extensions at the end of the URL, you can invoke these two operations.</para>
<informaltable>
<tgroup cols="3">
<thead>
@@ -241,7 +241,7 @@
<para>This is just a convenient way to specify the operation name as a file extension instead of specifying it as a request parameter.</para>
<note>
<title>Note</title>
- <para>The following URL's are equivalent:</para>
+ <para>The following URLs are equivalent:</para>
<itemizedlist>
<listitem>
<para>
@@ -361,12 +361,12 @@
<title>Browser Content Negotiation</title>
<para>
- To make it easy to control the content type of management requests through the browser, the rest component supports the
+ To make it easy to control the content type of management requests through the browser, the REST component supports the
<code>format</code>
HTTP parameter to dictate the format of the response. This is because most browsers already send an 'Accept' header.
</para>
<example>
- <title>Specifying the response should be returned as xml</title>
+ <title>Specifying the response should be returned as XML</title>
<programlisting>http://localhost:8080/rest/private/managed-components/foo/bar?format=xml</programlisting>
</example>
<para>
@@ -426,7 +426,7 @@
</informaltable>
<important>
<title>Important</title>
- <para>Content negotiation is ignored for content type specific operations such as 'read-config-as-xml' and 'export-resource' since these cannot return different formats.</para>
+ <para>Content negotiation is ignored for content type specific operations such as <systemitem>read-config-as-xml</systemitem> and <systemitem>export-resource</systemitem> since these cannot return different formats.</para>
</important>
</section>
<section id="sid-8094332_GateInManagement-readresource">
@@ -435,7 +435,7 @@
<para>
Since the
<code>read-resource</code>
- operation is a built in operation provided by the management component, as opposed to extensions, below documents the format of the response.
+ operation is a built-in operation provided by the management component, as opposed to extensions, the response is formatted as follows.
</para>
<example>
<title>HTTP Request</title>
@@ -478,7 +478,7 @@
</example>
<example>
<title>Response as XML</title>
- <programlisting>HTTP/1.1 200 OK
+ <programlisting language="XML">HTTP/1.1 200 OK
Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
More information about the gatein-commits
mailing list