From fc9cfb76c586f9d3465df2902937525a835a43da Mon Sep 17 00:00:00 2001 From: Samuel de Medeiros Queiroz Date: Tue, 2 Aug 2016 12:33:33 -0300 Subject: [PATCH] Move Mapping API to its own file Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation api-ref docs into keystone repository. Moving Mapping API to its own file is one of the TODO comments left there, which is being addressed in this change. Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be --- api-ref/source/v3-ext/federation.inc | 77 +------------------ .../v3-ext/federation/mapping/mapping.inc | 76 ++++++++++++++++++ .../v3-ext/federation/mapping/parameters.yaml | 7 ++ .../mapping/samples/create-request.json} | 0 .../mapping/samples/create-response.json} | 0 .../mapping/samples/get-response.json} | 0 .../mapping/samples/list-response.json} | 0 .../mapping/samples/update-request.json} | 0 .../mapping/samples/update-response.json} | 0 9 files changed, 84 insertions(+), 76 deletions(-) create mode 100644 api-ref/source/v3-ext/federation/mapping/mapping.inc create mode 100644 api-ref/source/v3-ext/federation/mapping/parameters.yaml rename api-ref/source/v3-ext/{samples/OS-FEDERATION/mapping-create-request.json => federation/mapping/samples/create-request.json} (100%) rename api-ref/source/v3-ext/{samples/OS-FEDERATION/mapping-create-response.json => federation/mapping/samples/create-response.json} (100%) rename api-ref/source/v3-ext/{samples/OS-FEDERATION/mapping-get-response.json => federation/mapping/samples/get-response.json} (100%) rename api-ref/source/v3-ext/{samples/OS-FEDERATION/mapping-list-response.json => federation/mapping/samples/list-response.json} (100%) rename api-ref/source/v3-ext/{samples/OS-FEDERATION/mapping-update-request.json => federation/mapping/samples/update-request.json} (100%) rename api-ref/source/v3-ext/{samples/OS-FEDERATION/mapping-update-response.json => federation/mapping/samples/update-response.json} (100%) diff --git a/api-ref/source/v3-ext/federation.inc b/api-ref/source/v3-ext/federation.inc index 7cb3fc028b..dafbc26b38 100644 --- a/api-ref/source/v3-ext/federation.inc +++ b/api-ref/source/v3-ext/federation.inc @@ -296,82 +296,7 @@ to ``ss:mem:``. .. include:: federation/identity-provider/idp.inc -.. TODO(samueldmq): This is the Mapping API, move it to its own file. - -Create a mapping -================ - -.. rest_method:: PUT /v3/OS-FEDERATION/mappings/{mapping_id} - -Normal response codes: 201 - -Request Example ---------------- - -.. literalinclude:: ./samples/OS-FEDERATION/mapping-create-request.json - :language: javascript - -Response Example ----------------- - -.. literalinclude:: ./samples/OS-FEDERATION/mapping-create-response.json - :language: javascript - - -Get a mapping -============= - -.. rest_method:: GET /v3/OS-FEDERATION/mappings/{mapping_id} - -Normal response codes: 200 - -Response Example ----------------- - -.. literalinclude:: ./samples/OS-FEDERATION/mapping-get-response.json - :language: javascript - - -Update a mapping -================ - -.. rest_method:: PATCH /v3/OS-FEDERATION/mappings/{mapping_id} - -Normal response codes: 200 - -Request Example ---------------- - -.. literalinclude:: ./samples/OS-FEDERATION/mapping-update-request.json - :language: javascript - -Response Example ----------------- - -.. literalinclude:: ./samples/OS-FEDERATION/mapping-update-response.json - :language: javascript - - -List all mappings -================= - -.. rest_method:: GET /v3/OS-FEDERATION/mappings - -Normal response codes: 200 - -Response Example ----------------- - -.. literalinclude:: ./samples/OS-FEDERATION/mapping-list-response.json - :language: javascript - - -Delete a mapping -================ - -.. rest_method:: DELETE /v3/OS-FEDERATION/mappings/{mapping_id} - -Normal response codes: 204 +.. include:: federation/mapping/mapping.inc .. TODO(samueldmq): This is the Service Provider API, move it to its own file. diff --git a/api-ref/source/v3-ext/federation/mapping/mapping.inc b/api-ref/source/v3-ext/federation/mapping/mapping.inc new file mode 100644 index 0000000000..fb28c4c102 --- /dev/null +++ b/api-ref/source/v3-ext/federation/mapping/mapping.inc @@ -0,0 +1,76 @@ +.. -*- rst -*- + +Create a mapping +================ + +.. rest_method:: PUT /v3/OS-FEDERATION/mappings/{mapping_id} + +Normal response codes: 201 + +Request Example +--------------- + +.. literalinclude:: federation/mapping/samples/create-request.json + :language: javascript + +Response Example +---------------- + +.. literalinclude:: federation/mapping/samples/create-response.json + :language: javascript + + +Get a mapping +============= + +.. rest_method:: GET /v3/OS-FEDERATION/mappings/{mapping_id} + +Normal response codes: 200 + +Response Example +---------------- + +.. literalinclude:: federation/mapping/samples/get-response.json + :language: javascript + + +Update a mapping +================ + +.. rest_method:: PATCH /v3/OS-FEDERATION/mappings/{mapping_id} + +Normal response codes: 200 + +Request Example +--------------- + +.. literalinclude:: federation/mapping/samples/update-request.json + :language: javascript + +Response Example +---------------- + +.. literalinclude:: federation/mapping/samples/update-response.json + :language: javascript + + +List all mappings +================= + +.. rest_method:: GET /v3/OS-FEDERATION/mappings + +Normal response codes: 200 + +Response Example +---------------- + +.. literalinclude:: federation/mapping/samples/list-response.json + :language: javascript + + +Delete a mapping +================ + +.. rest_method:: DELETE /v3/OS-FEDERATION/mappings/{mapping_id} + +Normal response codes: 204 diff --git a/api-ref/source/v3-ext/federation/mapping/parameters.yaml b/api-ref/source/v3-ext/federation/mapping/parameters.yaml new file mode 100644 index 0000000000..f5364194f2 --- /dev/null +++ b/api-ref/source/v3-ext/federation/mapping/parameters.yaml @@ -0,0 +1,7 @@ +# variables in header + +# variables in path + +# variables in query + +# variables in body diff --git a/api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-create-request.json b/api-ref/source/v3-ext/federation/mapping/samples/create-request.json similarity index 100% rename from api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-create-request.json rename to api-ref/source/v3-ext/federation/mapping/samples/create-request.json diff --git a/api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-create-response.json b/api-ref/source/v3-ext/federation/mapping/samples/create-response.json similarity index 100% rename from api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-create-response.json rename to api-ref/source/v3-ext/federation/mapping/samples/create-response.json diff --git a/api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-get-response.json b/api-ref/source/v3-ext/federation/mapping/samples/get-response.json similarity index 100% rename from api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-get-response.json rename to api-ref/source/v3-ext/federation/mapping/samples/get-response.json diff --git a/api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-list-response.json b/api-ref/source/v3-ext/federation/mapping/samples/list-response.json similarity index 100% rename from api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-list-response.json rename to api-ref/source/v3-ext/federation/mapping/samples/list-response.json diff --git a/api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-update-request.json b/api-ref/source/v3-ext/federation/mapping/samples/update-request.json similarity index 100% rename from api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-update-request.json rename to api-ref/source/v3-ext/federation/mapping/samples/update-request.json diff --git a/api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-update-response.json b/api-ref/source/v3-ext/federation/mapping/samples/update-response.json similarity index 100% rename from api-ref/source/v3-ext/samples/OS-FEDERATION/mapping-update-response.json rename to api-ref/source/v3-ext/federation/mapping/samples/update-response.json