-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Conflicts: apis/en/source/pages/application.wadl
- Loading branch information
Showing
74 changed files
with
9,516 additions
and
7,997 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
64 changes: 64 additions & 0 deletions
64
apis/en/source/pages/containers/containerTemplateImageGeneration_cancel.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
.. Copyright 2018 FUJITSU LIMITED | ||
.. _containerTemplateImageGeneration-cancel: | ||
|
||
containerTemplateImageGeneration_cancel | ||
--------------------------------------- | ||
|
||
.. function:: DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status | ||
|
||
.. sidebar:: Summary | ||
|
||
* Method: ``DELETE`` | ||
* Response Code: ``204 / 200`` | ||
* Response Formats: ``application/xml`` ``application/json`` | ||
* Since: ``UForge 3.8.8`` | ||
|
||
Cancels a running generation of a machine image generated from a container template. | ||
|
||
Security Summary | ||
~~~~~~~~~~~~~~~~ | ||
|
||
* Requires Authentication: ``true`` | ||
* Entitlements Required: ``image_generate`` | ||
|
||
URI Parameters | ||
~~~~~~~~~~~~~~ | ||
|
||
* ``uid`` (required): the user name (login name) of the :ref:`user-object` | ||
* ``msid`` (required): the id of the :ref:`mySoftware-object` | ||
* ``tiid`` (required): the id of the :ref:`image-object` | ||
* ``tid`` (required): the id of the :ref:`containertemplate-object` | ||
|
||
HTTP Request Body Parameters | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
None | ||
|
||
Example Request | ||
~~~~~~~~~~~~~~~ | ||
|
||
.. code-block:: bash | ||
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status" -X DELETE \ | ||
-u USER_LOGIN:PASSWORD -H "Accept: application/xml" | ||
.. seealso:: | ||
|
||
* :ref:`containerTemplateImageGeneration-get` | ||
* :ref:`containerTemplateImagePublish-cancel` | ||
* :ref:`containerTemplateImagePublish-get` | ||
* :ref:`containerTemplateImagePublished-delete` | ||
* :ref:`containerTemplateImagePublished-get` | ||
* :ref:`containerTemplateImage-delete` | ||
* :ref:`containerTemplateImage-download` | ||
* :ref:`containerTemplateImage-downloadFile` | ||
* :ref:`containerTemplateImage-get` | ||
* :ref:`containerTemplateImage-publish` | ||
* :ref:`containerTemplate-create` | ||
* :ref:`containerTemplate-generate` | ||
* :ref:`containerTemplate-get` | ||
* :ref:`containertemplate-object` | ||
* :ref:`image-object` | ||
* :ref:`mySoftware-object` | ||
* :ref:`status-object` |
64 changes: 64 additions & 0 deletions
64
apis/en/source/pages/containers/containerTemplateImageGeneration_get.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
.. Copyright 2018 FUJITSU LIMITED | ||
.. _containerTemplateImageGeneration-get: | ||
|
||
containerTemplateImageGeneration_get | ||
------------------------------------ | ||
|
||
.. function:: GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status | ||
|
||
.. sidebar:: Summary | ||
|
||
* Method: ``GET`` | ||
* Response Code: ``200 / 304`` | ||
* Response Formats: ``application/xml`` ``application/json`` | ||
* Since: ``UForge 3.8.8`` | ||
|
||
Retrieves the generation status of a machine image generated from a container template. | ||
|
||
Security Summary | ||
~~~~~~~~~~~~~~~~ | ||
|
||
* Requires Authentication: ``true`` | ||
* Entitlements Required: ``appliance_create`` | ||
|
||
URI Parameters | ||
~~~~~~~~~~~~~~ | ||
|
||
* ``uid`` (required): the user name (login name) of the :ref:`user-object` | ||
* ``msid`` (required): the id of the :ref:`mySoftware-object` | ||
* ``tiid`` (required): the id of the :ref:`image-object` | ||
* ``tid`` (required): the id of the :ref:`containertemplate-object` | ||
|
||
HTTP Request Body Parameters | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
None | ||
|
||
Example Request | ||
~~~~~~~~~~~~~~~ | ||
|
||
.. code-block:: bash | ||
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/status" -X GET \ | ||
-u USER_LOGIN:PASSWORD -H "Accept: application/xml" | ||
.. seealso:: | ||
|
||
* :ref:`containerTemplateImageGeneration-cancel` | ||
* :ref:`containerTemplateImagePublish-cancel` | ||
* :ref:`containerTemplateImagePublish-get` | ||
* :ref:`containerTemplateImagePublished-delete` | ||
* :ref:`containerTemplateImagePublished-get` | ||
* :ref:`containerTemplateImage-delete` | ||
* :ref:`containerTemplateImage-download` | ||
* :ref:`containerTemplateImage-downloadFile` | ||
* :ref:`containerTemplateImage-get` | ||
* :ref:`containerTemplateImage-publish` | ||
* :ref:`containerTemplate-create` | ||
* :ref:`containerTemplate-generate` | ||
* :ref:`containerTemplate-get` | ||
* :ref:`containertemplate-object` | ||
* :ref:`image-object` | ||
* :ref:`mySoftware-object` | ||
* :ref:`status-object` |
64 changes: 64 additions & 0 deletions
64
apis/en/source/pages/containers/containerTemplateImagePublish_cancel.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
.. Copyright 2018 FUJITSU LIMITED | ||
.. _containerTemplateImagePublish-cancel: | ||
|
||
containerTemplateImagePublish_cancel | ||
------------------------------------ | ||
|
||
.. function:: DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/cancel | ||
|
||
.. sidebar:: Summary | ||
|
||
* Method: ``DELETE`` | ||
* Response Code: ``204 / 200`` | ||
* Response Formats: ``application/xml`` ``application/json`` | ||
* Since: ``UForge 3.8.8`` | ||
|
||
Cancels a running publish of a machine image generated from a container template. | ||
|
||
Security Summary | ||
~~~~~~~~~~~~~~~~ | ||
|
||
* Requires Authentication: ``true`` | ||
* Entitlements Required: ``image_publish`` | ||
|
||
URI Parameters | ||
~~~~~~~~~~~~~~ | ||
|
||
* ``ptiid`` (required): the id of the :ref:`publishimage-object` | ||
* ``uid`` (required): the user name (login name) of the :ref:`user-object` | ||
* ``msid`` (required): the id of the :ref:`mySoftware-object` | ||
* ``tiid`` (required): the id of the :ref:`image-object` | ||
* ``tid`` (required): the id of the :ref:`containertemplate-object` | ||
|
||
HTTP Request Body Parameters | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
None | ||
|
||
Example Request | ||
~~~~~~~~~~~~~~~ | ||
|
||
.. code-block:: bash | ||
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/cancel" -X DELETE \ | ||
-u USER_LOGIN:PASSWORD -H "Accept: application/xml" | ||
.. seealso:: | ||
|
||
* :ref:`containerTemplateImageGeneration-cancel` | ||
* :ref:`containerTemplateImageGeneration-get` | ||
* :ref:`containerTemplateImagePublish-get` | ||
* :ref:`containerTemplateImagePublished-delete` | ||
* :ref:`containerTemplateImagePublished-get` | ||
* :ref:`containerTemplateImage-delete` | ||
* :ref:`containerTemplateImage-download` | ||
* :ref:`containerTemplateImage-downloadFile` | ||
* :ref:`containerTemplateImage-get` | ||
* :ref:`containerTemplateImage-publish` | ||
* :ref:`containerTemplate-create` | ||
* :ref:`containerTemplate-generate` | ||
* :ref:`containerTemplate-get` | ||
* :ref:`containertemplate-object` | ||
* :ref:`mySoftware-object` | ||
* :ref:`status-object` |
64 changes: 64 additions & 0 deletions
64
apis/en/source/pages/containers/containerTemplateImagePublish_get.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
.. Copyright 2018 FUJITSU LIMITED | ||
.. _containerTemplateImagePublish-get: | ||
|
||
containerTemplateImagePublish_get | ||
--------------------------------- | ||
|
||
.. function:: GET /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/status | ||
|
||
.. sidebar:: Summary | ||
|
||
* Method: ``GET`` | ||
* Response Code: ``200 / 304`` | ||
* Response Formats: ``application/xml`` ``application/json`` | ||
* Since: ``UForge 3.8.8`` | ||
|
||
Retrieves the publish status of a machine image generated from a container template. | ||
|
||
Security Summary | ||
~~~~~~~~~~~~~~~~ | ||
|
||
* Requires Authentication: ``true`` | ||
* Entitlements Required: ``image_publish`` | ||
|
||
URI Parameters | ||
~~~~~~~~~~~~~~ | ||
|
||
* ``ptiid`` (required): the id of the :ref:`publishimage-object` | ||
* ``uid`` (required): the user name (login name) of the :ref:`user-object` | ||
* ``msid`` (required): the id of the :ref:`mySoftware-object` | ||
* ``tiid`` (required): the id of the :ref:`image-object` | ||
* ``tid`` (required): the id of the :ref:`containertemplate-object` | ||
|
||
HTTP Request Body Parameters | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
None | ||
|
||
Example Request | ||
~~~~~~~~~~~~~~~ | ||
|
||
.. code-block:: bash | ||
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}/status" -X GET \ | ||
-u USER_LOGIN:PASSWORD -H "Accept: application/xml" | ||
.. seealso:: | ||
|
||
* :ref:`containerTemplateImageGeneration-cancel` | ||
* :ref:`containerTemplateImageGeneration-get` | ||
* :ref:`containerTemplateImagePublish-cancel` | ||
* :ref:`containerTemplateImagePublished-delete` | ||
* :ref:`containerTemplateImagePublished-get` | ||
* :ref:`containerTemplateImage-delete` | ||
* :ref:`containerTemplateImage-download` | ||
* :ref:`containerTemplateImage-downloadFile` | ||
* :ref:`containerTemplateImage-get` | ||
* :ref:`containerTemplateImage-publish` | ||
* :ref:`containerTemplate-create` | ||
* :ref:`containerTemplate-generate` | ||
* :ref:`containerTemplate-get` | ||
* :ref:`containertemplate-object` | ||
* :ref:`mySoftware-object` | ||
* :ref:`status-object` |
63 changes: 63 additions & 0 deletions
63
apis/en/source/pages/containers/containerTemplateImagePublished_delete.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
.. Copyright 2018 FUJITSU LIMITED | ||
.. _containerTemplateImagePublished-delete: | ||
|
||
containerTemplateImagePublished_delete | ||
-------------------------------------- | ||
|
||
.. function:: DELETE /users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid} | ||
|
||
.. sidebar:: Summary | ||
|
||
* Method: ``DELETE`` | ||
* Response Code: ``204 / 200`` | ||
* Response Formats: | ||
* Since: ``UForge 3.8.8`` | ||
|
||
Deletes a published machine image for a container template. | ||
|
||
Security Summary | ||
~~~~~~~~~~~~~~~~ | ||
|
||
* Requires Authentication: ``true`` | ||
* Entitlements Required: ``image_publish`` | ||
|
||
URI Parameters | ||
~~~~~~~~~~~~~~ | ||
|
||
* ``ptiid`` (required): the id of the :ref:`publishimage-object` | ||
* ``uid`` (required): the user name (login name) of the :ref:`user-object` | ||
* ``msid`` (required): the id of the :ref:`mySoftware-object` | ||
* ``tiid`` (required): the id of the :ref:`image-object` | ||
* ``tid`` (required): the id of the :ref:`containertemplate-object` | ||
|
||
HTTP Request Body Parameters | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
None | ||
|
||
Example Request | ||
~~~~~~~~~~~~~~~ | ||
|
||
.. code-block:: bash | ||
curl "https://uforge.example.com/api/users/{uid}/mysoftware/{msid}/templates/{tid}/images/{tiid}/pimages/{ptiid}" -X DELETE \ | ||
-u USER_LOGIN:PASSWORD -H "Accept: application/xml" | ||
.. seealso:: | ||
|
||
* :ref:`containerTemplateImageGeneration-cancel` | ||
* :ref:`containerTemplateImageGeneration-get` | ||
* :ref:`containerTemplateImagePublish-cancel` | ||
* :ref:`containerTemplateImagePublish-get` | ||
* :ref:`containerTemplateImagePublished-get` | ||
* :ref:`containerTemplateImage-delete` | ||
* :ref:`containerTemplateImage-download` | ||
* :ref:`containerTemplateImage-downloadFile` | ||
* :ref:`containerTemplateImage-get` | ||
* :ref:`containerTemplateImage-publish` | ||
* :ref:`containerTemplate-create` | ||
* :ref:`containerTemplate-generate` | ||
* :ref:`containerTemplate-get` | ||
* :ref:`containertemplate-object` | ||
* :ref:`mySoftware-object` |
Oops, something went wrong.