Move Identity Provider API to its own file

Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Identity Provider API to its own file is one of the TODO
comments left there, which is being addressed in this change.

Change-Id: I5c5b26c2d4c9920d6b9642eaf0fc47ed5bffb3cb

api-ref/source/v3-ext/federation.inc

@@ -294,168 +294,6 @@ If a value is not specified by the client, the service will default this value
 to ``ss:mem:``.
 
 
-.. TODO(samueldmq): This is the Identity Provider API, move it to its own file.
-
-Register an Identity Provider
-=============================
-
-.. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}
-
-Normal response codes: 201
-Error response codes: 409
-
-Request Example
----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-register-request.json
-   :language: javascript
-
-Response Example
-----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-register-response.json
-   :language: javascript
-
-
-List identity providers
-=======================
-
-.. rest_method::  GET /v3/OS-FEDERATION/identity_providers
-
-Normal response codes: 200
-
-Response Example
-----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-list-response.json
-   :language: javascript
-
-
-Get Identity provider
-=====================
-
-.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}
-
-Normal response codes: 200
-
-Response Example
-----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-get-response.json
-   :language: javascript
-
-
-Delete identity provider
-========================
-
-.. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}
-
-When an identity provider is deleted, any tokens generated by that identity
-provider will be revoked.
-
-Normal response codes: 204
-
-
-Update identity provider
-========================
-
-.. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}
-
-When an identity provider is disabled, any tokens generated by that identity
-provider will be revoked.
-
-Normal response codes: 200
-Error response codes: 409
-
-Request Example
----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-update-request.json
-   :language: javascript
-
-Response Example
-----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-update-response.json
-   :language: javascript
-
-
-Add a protocol and attribute mapping to an identity provider
-============================================================
-
-.. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
-
-Normal response codes: 201
-
-Request Example
----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-add-protocol-request.json
-   :language: javascript
-
-Response Example
-----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-add-protocol-response.json
-   :language: javascript
-
-
-List all protocol and attribute mappings of an identity provider
-================================================================
-
-.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols
-
-Normal response codes: 200
-
-Response Example
-----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-list-protocol-response.json
-   :language: javascript
-
-
-Get a protocol and attribute mapping for an identity provider
-=============================================================
-
-.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
-
-Normal response codes: 200
-
-Response Example
-----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-get-protocol-response.json
-   :language: javascript
-
-
-Update the attribute mapping for an identity provider and protocol
-==================================================================
-
-.. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
-
-Normal response codes: 200
-
-Request Example
----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-update-protocol-request.json
-   :language: javascript
-
-Response Example
-----------------
-
-.. literalinclude:: ./samples/OS-FEDERATION/idp-update-protocol-response.json
-   :language: javascript
-
-
-Delete a protocol and attribute mapping from an identity provider
-=================================================================
-
-.. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
-
-Normal response codes: 204
-
-
 .. TODO(samueldmq): This is the Mapping API, move it to its own file.
 
 Create a mapping

api-ref/source/v3-ext/federation/identity-provider/index.inc

@@ -0,0 +1,168 @@
+.. -*- rst -*-
+
+=====================================
+ OS-FEDERATION IDENTITY PROVIDER API
+=====================================
+
+Provide the ability for users to manage Identity Providers (IdPs). Requires
+v3.0+ of the Identity API.
+
+
+Register an Identity Provider
+=============================
+
+.. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}
+
+Normal response codes: 201
+Error response codes: 409
+
+Request Example
+---------------
+
+.. literalinclude:: federation/identity-provider/samples/register-request.json
+   :language: javascript
+
+Response Example
+----------------
+
+.. literalinclude:: federation/identity-provider/samples/register-response.json
+   :language: javascript
+
+
+List identity providers
+=======================
+
+.. rest_method::  GET /v3/OS-FEDERATION/identity_providers
+
+Normal response codes: 200
+
+Response Example
+----------------
+
+.. literalinclude:: federation/identity-provider/samples/list-response.json
+   :language: javascript
+
+
+Get Identity provider
+=====================
+
+.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}
+
+Normal response codes: 200
+
+Response Example
+----------------
+
+.. literalinclude:: federation/identity-provider/samples/get-response.json
+   :language: javascript
+
+
+Delete identity provider
+========================
+
+.. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}
+
+When an identity provider is deleted, any tokens generated by that identity
+provider will be revoked.
+
+Normal response codes: 204
+
+
+Update identity provider
+========================
+
+.. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}
+
+When an identity provider is disabled, any tokens generated by that identity
+provider will be revoked.
+
+Normal response codes: 200
+Error response codes: 409
+
+Request Example
+---------------
+
+.. literalinclude:: federation/identity-provider/samples/update-request.json
+   :language: javascript
+
+Response Example
+----------------
+
+.. literalinclude:: federation/identity-provider/samples/update-response.json
+   :language: javascript
+
+
+Add a protocol and attribute mapping to an identity provider
+============================================================
+
+.. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
+
+Normal response codes: 201
+
+Request Example
+---------------
+
+.. literalinclude:: federation/identity-provider/samples/add-protocol-request.json
+   :language: javascript
+
+Response Example
+----------------
+
+.. literalinclude:: federation/identity-provider/samples/add-protocol-response.json
+   :language: javascript
+
+
+List all protocol and attribute mappings of an identity provider
+================================================================
+
+.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols
+
+Normal response codes: 200
+
+Response Example
+----------------
+
+.. literalinclude:: federation/identity-provider/samples/list-protocol-response.json
+   :language: javascript
+
+
+Get a protocol and attribute mapping for an identity provider
+=============================================================
+
+.. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
+
+Normal response codes: 200
+
+Response Example
+----------------
+
+.. literalinclude:: federation/identity-provider/samples/get-protocol-response.json
+   :language: javascript
+
+
+Update the attribute mapping for an identity provider and protocol
+==================================================================
+
+.. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
+
+Normal response codes: 200
+
+Request Example
+---------------
+
+.. literalinclude:: federation/identity-provider/samples/update-protocol-request.json
+   :language: javascript
+
+Response Example
+----------------
+
+.. literalinclude:: federation/identity-provider/samples/update-protocol-response.json
+   :language: javascript
+
+
+Delete a protocol and attribute mapping from an identity provider
+=================================================================
+
+.. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
+
+Normal response codes: 204

api-ref/source/v3-ext/federation/identity-provider/parameters.yaml

@@ -0,0 +1,7 @@
+# variables in header
+
+# variables in path
+
+# variables in query
+
+# variables in body

api-ref/source/v3-ext/federation/index.inc

@@ -0,0 +1,2 @@
+
+.. include:: federation/identity-provider/index.inc

api-ref/source/v3-ext/index.rst

@@ -12,6 +12,7 @@ This page describes these Identity API v3 extensions:
 * `OS-REVOKE API`_
 * `OS-EP-FILTER API`_
 * `OS-FEDERATION API`_
+* `OS-FEDERATION IDENTITY PROVIDER API`_
 
 .. rest_expand_all::
 
@@ -21,3 +22,4 @@ This page describes these Identity API v3 extensions:
 .. include:: revoke.inc
 .. include:: ep-filter.inc
 .. include:: federation.inc
+.. include:: federation/index.inc