Add api-ref /auth/tokens/OS-PKI/revoked (v3)

The v3 endpoint documentation /v3/auth/tokens/OS-PKI/revoked is missing
in /api-ref.  This patch set adds the documentation for v3.
A separate patch set will be submitted for v2.

Change-Id: I3db3356d24cc8885012756016a90a0996fcf14f5
Partial-Bug: #1626778
This commit is contained in:
Tin Lam 2016-10-26 10:43:20 -05:00 committed by Steve Martinelli
parent b8435cc152
commit 095ed9187b
4 changed files with 44 additions and 0 deletions

View File

@ -37,6 +37,7 @@ This page lists the Identity API operations in the following order:
* `Service catalog and endpoints`_
* `Users`_
* `OS-INHERIT API`_
* `OS-PKI API`_
.. rest_expand_all::
@ -46,6 +47,7 @@ This page lists the Identity API operations in the following order:
.. include:: domains-config-v3.inc
.. include:: groups.inc
.. include:: inherit.inc
.. include:: os-pki.inc
.. include:: policies.inc
.. include:: projects.inc
.. include:: regions-v3.inc

View File

@ -0,0 +1,32 @@
.. -*- rst -*-
==========
OS-PKI API
==========
List revoked tokens
===================
.. rest_method:: GET /v3/auth/tokens/OS-PKI/revoked
Relationship:
``http://docs.openstack.org/api/openstack-identity/3/rel/tokens/OS-PKI/revoked``
Lists revoked PKI tokens.
Normal response codes: 200
Error response codes: 413,415,405,404,403,401,400,503,409
Response
--------
.. rest_parameters:: parameters.yaml
- signed: signed
Response Example
----------------
.. literalinclude:: samples/admin/get-pki-revoked-response.json
:language: javascript

View File

@ -1595,6 +1595,13 @@ services:
in: body
required: true
type: array
signed:
description: |
List of expired PKI tokens, signed by the
cryptographic message syntax (CMS).
in: body
required: true
type: string
token:
description: |
A ``token`` object.

View File

@ -0,0 +1,3 @@
{
"signed": "-----BEGIN CMS-----\nMIICGwYJKoZIhvcNAQcCoIICDDCCAggCAQExDTALBglghkgBZQMEAgEwawYJKoZI\nhvcNAQcBoF4EXHsicmV2b2tlZCI6IFt7ImV4cGlyZXMiOiAiMjAxNC0xMi0wMlQx\nNzowMDowOVoiLCAiaWQiOiAiODhiMjRmOTI5OTk0NGU1ZjhkODE0MDNjYzMyY2M5\nMmUifV19MYIBhTCCAYECAQEwXDBXMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVW5z\nZXQxDjAMBgNVBAcMBVVuc2V0MQ4wDAYDVQQKDAVVbnNldDEYMBYGA1UEAwwPd3d3\nLmV4YW1wbGUuY29tAgEBMAsGCWCGSAFlAwQCATANBgkqhkiG9w0BAQEFAASCAQA3\nc8EI58ZXtqkyuUWqLPJZdB5v7Ou978w22YkOsgL5ruUpQiWdhdgvL/sxqd7OPqi7\nZZV3N+io+z1m4uAiSbriumv7HOEnIUEAUhK4G0kw5kAAg4j50c0Omdiqdq75k0j/\nJPoRCXa8ieb0X87zhgfIq7ze/HZ7E2LoO20us3AEzmglNv023qgGcsSGPAUIHWN5\nloonPtgztiwVbmS2gs3Z9JB73mxEBviCX4CZEU/sNpchAzI/53tscKlqlzv+GBcm\n1dYP3hEZn3twFRI9zos4hTwFkUivn6D3qgQB684sVrvKlzOCIqOKVGGYVSy/FQLE\nWwQ5u58ZD8ohaJPu2Q6l\n-----END CMS-----\n"
}