Go to file

Nathan Kinder 363af89051 Correct response status for HEAD requests

The response status for some HEAD calls was changed to follow the
HTTP specification a while back.  Specifically, any call that supports
both GET and HEAD methods should return the same response code.  The
API docs still list all successfull HEAD requests with a response code
of 204, which is not correct in all cases.

This patch adjusts the expected response status for HEAD calls to
match the actual implementation.

Change-Id: I6f518ebbe00a0b2860ca5db0d10b93f313abd488
Related-bug: #1334368

2014-10-03 17:35:16 -07:00

tools

Remove trailing whitespaces in regular file

2012-03-09 16:14:21 +08:00

v2.0

Removes WADL references from Identity v2.0 API

2014-08-08 10:32:07 -05:00

Correct response status for HEAD requests

2014-10-03 17:35:16 -07:00

.gitignore

doc-tools: Ignore build-*.log.gz

2014-02-08 22:10:48 +01:00

.gitreview

Add .gitreview config file for gerrit.

2011-10-24 11:02:31 -04:00

doc-test.conf

Set up for publishing via openstack-doc-tools

2014-02-14 17:48:52 +01:00

pom.xml

Update to clouddocs-maven-plugin 2.1.3

2014-09-22 19:57:43 +02:00

README.rst

Change package to build docs to correct name

2014-04-07 14:03:41 -05:00

test-requirements.txt

Updated from global requirements

2014-09-11 00:25:27 +00:00

tox.ini

Add new checklinks tox environment

2014-08-16 12:06:31 +02:00

README.rst

Identity Service API

This repository contains the RESTful API information for the OpenStack Identity Service, also known as the Keystone project. The Keystone project provides authentication for OpenStack services, with plans to also provide authorization.

Building v2.0 Docs

Build these docs using the same procedure as documented for the openstack-manuals project: https://github.com/openstack/openstack-manuals

In short, with Maven 3:

cd openstack-identity-api/v2.0
mvn clean generate-sources

Building v3 Docs

The v3 docs require an extra proprocessing to convert the Markdown source into the DocBook format required by the Maven build process. A few extra tools are required for this preprocessing step.

Installing conversion tools on Ubuntu:

apt-get install pandoc xsltproc docbook5-xml

To build the docs:

cd openstack-identity-api/v3 ./preprocess.sh mvn clean generate-sources

Testing of changes and building of the manual

Install the python tox package and run tox from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

tox -e checkniceness - to run the niceness tests

tox -e checksyntax - to run syntax checks

tox -e checkdeletions - to check that no deleted files are referenced

tox -e checkbuild - to actually build the manual

tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.

Contributing

Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

Installing

Refer to http://keystone.openstack.org to learn more about installing an OpenStack Identity Service server that can respond to these API commands.