From af7800454b207acc0057a5360e5badb5036d538c Mon Sep 17 00:00:00 2001
From: Vishakha Agarwal <agarwalvishakha18@gmail.com>
Date: Thu, 8 Aug 2019 01:12:10 +0530
Subject: Update api-ref for revocation list OS-PKI

Since PKI tokens are removed and  OS-PKI API
is deprecated, updating api-ref for it [1].

[1] https://review.opendev.org/#/c/672334

Change-Id: I06a9d07225977469341851ea604df75976b105ca
---
 api-ref/source/v3/index.rst                        |  2 +-
 api-ref/source/v3/os-pki.inc                       | 33 +++-------------------
 api-ref/source/v3/parameters.yaml                  |  7 -----
 .../v3/samples/admin/get-pki-revoked-response.json |  3 --
 api-ref/source/v3/status.yaml                      |  3 ++
 5 files changed, 8 insertions(+), 40 deletions(-)
 delete mode 100644 api-ref/source/v3/samples/admin/get-pki-revoked-response.json

(limited to 'api-ref')

diff --git a/api-ref/source/v3/index.rst b/api-ref/source/v3/index.rst
index 5e9866876..0a67115a3 100644
--- a/api-ref/source/v3/index.rst
+++ b/api-ref/source/v3/index.rst
@@ -216,7 +216,7 @@ This page lists the Identity API operations in the following order:
 * `Unified Limits`_
 * `Users`_
 * `OS-INHERIT`_
-* `OS-PKI`_
+* `OS-PKI (DEPRECATED)`_
 
 .. rest_expand_all::
 
diff --git a/api-ref/source/v3/os-pki.inc b/api-ref/source/v3/os-pki.inc
index 934c283b6..aa2f4d835 100644
--- a/api-ref/source/v3/os-pki.inc
+++ b/api-ref/source/v3/os-pki.inc
@@ -1,8 +1,8 @@
 .. -*- rst -*-
 
-==========
-OS-PKI
-==========
+===================
+OS-PKI (DEPRECATED)
+===================
 
 List revoked tokens
 ===================
@@ -17,34 +17,9 @@ Relationship:
 Response
 --------
 
-Parameters
-~~~~~~~~~~
-
-.. rest_parameters:: parameters.yaml
-
-   - signed: signed
-
 Status Codes
 ~~~~~~~~~~~~
 
-.. rest_status_code:: success status.yaml
-
-   - 200
-
 .. rest_status_code:: error status.yaml
 
-   - 413
-   - 415
-   - 405
-   - 404
-   - 403
-   - 401
-   - 400
-   - 503
-   - 409
-
-Example
-~~~~~~~
-
-.. literalinclude:: samples/admin/get-pki-revoked-response.json
-   :language: javascript
\ No newline at end of file
+   - 410
diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml
index 8615e053a..3cdf32864 100644
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@@ -1958,13 +1958,6 @@ 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
 system:
   description: |
     A ``system`` object.
diff --git a/api-ref/source/v3/samples/admin/get-pki-revoked-response.json b/api-ref/source/v3/samples/admin/get-pki-revoked-response.json
deleted file mode 100644
index 392e76536..000000000
--- a/api-ref/source/v3/samples/admin/get-pki-revoked-response.json
+++ /dev/null
@@ -1,3 +0,0 @@
-{
-  "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"
-}
diff --git a/api-ref/source/v3/status.yaml b/api-ref/source/v3/status.yaml
index e026069ac..0502ba12f 100644
--- a/api-ref/source/v3/status.yaml
+++ b/api-ref/source/v3/status.yaml
@@ -50,6 +50,9 @@
 409:
   default: |
     This operation conflicted with another operation on this resource.
+410:
+  default: |
+    The access request to the target resource is no longer available.
 413:
   default: |
     The request is larger than the server is willing or able to process.
-- 
cgit v1.2.1