Commit 8b897264 authored by cdanger's avatar cdanger
Browse files

Fixed doc syntax issues

parent dbc2e69e
...@@ -29,7 +29,7 @@ Minimal ...@@ -29,7 +29,7 @@ Minimal
| ``$ sudo gdebi authzforce-ce-server_4.3.0_all.deb`` | ``$ sudo gdebi authzforce-ce-server_4.3.0_all.deb``
#. At the end, you will see a message giving optional instructions to go through. Please follow them as necessary. #. At the end, you will see a message giving optional instructions to go through. Please follow them as necessary.
Note that Tomcat default configuration may specify a very low value for the Java Xmx flag, causing the authzforce webapp startup to fail. In that case, make sure tomcat with Xmx at 1Go or more (2 Go recommended). For example, for ubuntu 12.04, tomcat default Xmx used to be 128m. You can fix it as follows: Note that Tomcat default configuration may specify a very low value for the Java Xmx flag, causing the authzforce webapp startup to fail. In that case, make sure Tomcat with Xmx at 1Go or more (2 Go recommended). For example, for ubuntu 12.04, Tomcat default Xmx used to be 128m. You can fix it as follows:
| ``$ sudo sed -i "s/-Xmx128m/-Xmx1024m/" /etc/default/tomcat`` | ``$ sudo sed -i "s/-Xmx128m/-Xmx1024m/" /etc/default/tomcat``
| ``$ sudo service tomcat7 restart`` | ``$ sudo service tomcat7 restart``
...@@ -132,9 +132,10 @@ To check the proper deployment and operation of the Authorization Server, perfor ...@@ -132,9 +132,10 @@ To check the proper deployment and operation of the Authorization Server, perfor
Status Code: 200 OK Status Code: 200 OK
Content-Type: application/xml Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resources xmlns:ns2="http://authzforce.github.io/rest-api-model/xmlns/authz/4"> <ns2:resources xmlns:ns2="http://authzforce.github.io/rest-api-model/xmlns/authz/4">
... list of links to policy domains omitted here... ... list of links to policy domains omitted here...
</ns2:resources> </ns2:resources>
You can check the exact body format in the representation element of response code 200 for method ``getDomains``, and all other API resources and operations in general, in the WADL (Web Application Description Language) document available at the following URL:: You can check the exact body format in the representation element of response code 200 for method ``getDomains``, and all other API resources and operations in general, in the WADL (Web Application Description Language) document available at the following URL::
......
...@@ -55,7 +55,6 @@ You may retrieve the current domain properties as follows: ...@@ -55,7 +55,6 @@ You may retrieve the current domain properties as follows:
* Path: /domains/{domainId}/properties * Path: /domains/{domainId}/properties
* Headers: * Headers:
* Accept: application/xml; charset=UTF-8 * Accept: application/xml; charset=UTF-8
* Body: current properties.
For example, this request updates the externalId and the root policy reference some policy 'PolicyABC' that must exist in the domain (added via the PAP API mentioned later) as a prerequisite:: For example, this request updates the externalId and the root policy reference some policy 'PolicyABC' that must exist in the domain (added via the PAP API mentioned later) as a prerequisite::
...@@ -68,13 +67,15 @@ For example, this request updates the externalId and the root policy reference s ...@@ -68,13 +67,15 @@ For example, this request updates the externalId and the root policy reference s
<rootPolicyRef Version="1.0">PolicyABC</rootPolicyRef> <rootPolicyRef Version="1.0">PolicyABC</rootPolicyRef>
</ns4:domainProperties> </ns4:domainProperties>
You may update the domain properties as follows:: You may update the domain properties as follows:
* Method: PUT * Method: PUT
* Path: /domains/{domainId}/properties * Path: /domains/{domainId}/properties
* Headers: * Headers:
* Content-Type: application/xml; charset=UTF-8
* Accept: application/xml; charset=UTF-8 * Content-Type: application/xml; charset=UTF-8
* Accept: application/xml; charset=UTF-8
* Body: new properties. * Body: new properties.
For example, this request updates the externalId and the root policy reference some policy 'PolicyABC' that must exist in the domain (added via the PAP API mentioned later) as a prerequisite:: For example, this request updates the externalId and the root policy reference some policy 'PolicyABC' that must exist in the domain (added via the PAP API mentioned later) as a prerequisite::
...@@ -89,7 +90,7 @@ For example, this request updates the externalId and the root policy reference s ...@@ -89,7 +90,7 @@ For example, this request updates the externalId and the root policy reference s
<rootPolicyRef Version="2.1">PolicyDEF</rootPolicyRef> <rootPolicyRef Version="2.1">PolicyDEF</rootPolicyRef>
</ns4:domainProperties> </ns4:domainProperties>
Note that the *Version' attribute is optional here. If omitted, the latest version available is used. Note that the *Version* attribute is optional here. If omitted, the latest version available is used.
The response is the new properties. The response is the new properties.
...@@ -234,11 +235,12 @@ For example:: ...@@ -234,11 +235,12 @@ For example::
The response is the policy document (XACML PolicySet) in this version. The response is the policy document (XACML PolicySet) in this version.
Last but not least, you may get all policies in the domain as follows:: Last but not least, you may get all policies in the domain as follows:
* Method: GET * Method: GET
* Path: /domains/{domainId}/pap/policies * Path: /domains/{domainId}/pap/policies
* Headers: * Headers:
* Accept: application/xml; charset=UTF-8 * Accept: application/xml; charset=UTF-8
For example:: For example::
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment