Merge pull request #111 from NetAppDocs/issue-110

Issue 110

fsx/fsx.json

@@ -2,7 +2,7 @@
    "openapi":"3.0.0",
    "info":{
       "title":"Fsx for Ontap service API",
-      "description":"  <details><summary>Overview</summary>\n<p>Amazon FSx for ONTAP is a Cloud Manager service that enables you to create, operate, and delete Amazon FSx storage facilities for ONTAP systems.<br />\nFor more information about FSx for ONTAP, see <a href=\"https://docs.netapp.com/us-en/cloud-manager-fsx-ontap/index.html\">Cloud Manager FSx ONTAP</a>.</p>\n<p>There are four categories of API endpoints defined within the FSx for ONTAP service:</p>\n<ul>\n<li>AWS operations</li>\n<li>AWS credentials</li>\n<li>Working environments</li>\n<li>FSx ONTAP discovery</li></ul>\n<p>References</p>\n<ul>\n<li><a href=\"https://docs.netapp.com/us-en/cloud-manager-fsx-ontap/start/task-getting-started-fsx.html\">Quick start for FSx for ONTAP</a></li>\n<li><a href=\"https://docs.netapp.com/us-en/cloud-manager-fsx-ontap/requirements/task-setting-up-permissions-fsx.html\">Permissions required to create FSx</a></li>\n</ul>\n</details>\n<hr />\n   <details>\n<summary>REST implementation</summary>\n<h3>HTTP methods</h3>\n<table>\n<thead>\n<tr>\n<th>Method</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>POST</code></td>\n<td>Create an object instance</td>\n</tr>\n<tr>\n<td><code>GET</code></td>\n<td>Retrieve an object instance or collection</td>\n</tr>\n<tr>\n<td><code>PUT</code></td>\n<td>Update specified properties of existing objects</td>\n</tr>\n<tr>\n<td><code>DELETE</code></td>\n<td>Remove an existing object</td>\n</tr>\n</tbody>\n</table>\n<h3>Request headers</h3>\n<table>\n<thead>\n<tr>\n<th>Request Header</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>Authorization</code></td>\n<td>Required. Contains a JWT access token</td>\n</tr>\n<tr>\n<td><code>X-Service-Request-Id</code></td>\n<td>Request ID to use in logs</td>\n</tr>\n<tr>\n<td><code>x-simulator</code></td>\n<td>Indicates whether this API call is simulated or real</td>\n</tr>\n</tbody>\n</table>\n<h3>Query parameters</h3>\n<p>You can use query parameters with endpoints in the following components:</p>\n<table>\n<thead>\n<tr>\n<th>Component</th>\n<th>Query Parameter</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>isGov</code></td>\n<td>- Used to decide whether FSx storage is located in the governed location</td>\n</tr>\n<tr>\n<td><code>region</code></td>\n<td>- The API will be executed in the specified region</td>\n</tr>\n<tr>\n<td><code>workspace-id</code></td>\n<td>- The Cloud Manager workspace</td>\n</tr>\n</tbody>\n</table>\n<h4>Path parameters</h4>\n<p>You can use path parameters with endpoints.</p>\n<table>\n<thead>\n<tr>\n<th>Component</th>\n<th>Query Parameter</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>account-id</code></td>\n<td>Tenancy account ID for this API</td>\n</tr>\n<tr>\n<td><code>workingEnvironmentId</code></td>\n<td>FSx working environment ID used to execute this API</td>\n</tr>\n</tbody>\n</table>\n<h3>Response headers</h3>\n<p>This API uses the standard HTTP response headers common with all Cloud Manager APIs. See <a href=\"https://docs.netapp.com/us-en/cloud-manager-automation/platform/rest_implementation.html\">REST implementation</a> for more information.</p>\n<h3>HTTP status codes</h3>\n<table>\n<thead>\n<tr>\n<th>HTTP Status Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>200</code></td>\n<td>OK: Returned for successful operation completion</td>\n</tr>\n<tr>\n<td><code>400</code></td>\n<td>Bad Request: Returned if the input is malformed and could not be parsed</td>\n</tr>\n<tr>\n<td><code>401</code></td>\n<td>Unauthorized: Returned if user authentication failed or the token has expired</td>\n</tr>\n<tr>\n<td><code>403</code></td>\n<td>Forbidden: Returned for authorization errors depending on the resource and token</td>\n</tr>\n<tr>\n<td><code>404</code></td>\n<td>Not Found: Returned if the requested resource could not be found</td>\n</tr>\n<tr>\n<td><code>500</code></td>\n<td>Processing Error: Returned if an error occurs on the server while processing the API call</td>\n</tr>\n</tbody>\n</table>\n</details>\n<hr />\n   <details>\n<summary>Error handling</summary>\n<p>There are three processes involved with error handling and processing:</p>\n<ul>\n<li>The error is logged for supportability</li>\n<li>The error is returned to the caller for specific handling</li>\n<li>The database connection is rolled back</li>\n</ul>\n</details>\n<hr />\n   <details>\n<summary>cURL examples</summary>\n<h3>Retrieve FSx working environments for a specified account ID</h3>\n<p>This cURL example retrieves FSx working environments for a specified account ID.</p>\n<pre><code class=\"language-bash\">curl -X GET &quot;https://staging.cloudmanager.cloud.netapp.com/fsx-ontap/working-environments/&lt;accountId&gt;&quot;\n -H  &quot;accept: application/json&quot; -H  &quot;authorization: &lt;user token&gt;&quot;\n</code></pre>\n</details>\n<hr />\n   <br><br>",
+      "description":"  <details><summary>Overview</summary>\n<p>Amazon FSx for NetApp ONTAP is a Cloud Manager service that enables you to create, operate, and delete Amazon FSx storage facilities for ONTAP systems.<br />\nFor more information about FSx for ONTAP, see <a href=\"https://docs.netapp.com/us-en/cloud-manager-fsx-ontap/index.html\">Cloud Manager FSx ONTAP</a>.</p>\n<p>There are four categories of API endpoints defined within the FSx for ONTAP service:</p>\n<ul>\n<li>AWS operations</li>\n<li>AWS credentials</li>\n<li>Working environments</li>\n<li>FSx ONTAP discovery</li></ul>\n<p>References</p>\n<ul>\n<li><a href=\"https://docs.netapp.com/us-en/cloud-manager-fsx-ontap/start/task-getting-started-fsx.html\">Quick start for FSx for ONTAP</a></li>\n<li><a href=\"https://docs.netapp.com/us-en/cloud-manager-fsx-ontap/requirements/task-setting-up-permissions-fsx.html\">Permissions required to create FSx</a></li>\n</ul>\n</details>\n<hr />\n   <details>\n<summary>REST implementation</summary>\n<h3>HTTP methods</h3>\n<table>\n<thead>\n<tr>\n<th>Method</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>POST</code></td>\n<td>Create an object instance</td>\n</tr>\n<tr>\n<td><code>GET</code></td>\n<td>Retrieve an object instance or collection</td>\n</tr>\n<tr>\n<td><code>PUT</code></td>\n<td>Update specified properties of existing objects</td>\n</tr>\n<tr>\n<td><code>DELETE</code></td>\n<td>Remove an existing object</td>\n</tr>\n</tbody>\n</table>\n<h3>Request headers</h3>\n<table>\n<thead>\n<tr>\n<th>Request Header</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>Authorization</code></td>\n<td>Required. Contains a JWT access token</td>\n</tr>\n<tr>\n<td><code>X-Service-Request-Id</code></td>\n<td>Request ID to use in logs</td>\n</tr>\n<tr>\n<td><code>x-simulator</code></td>\n<td>Indicates whether this API call is simulated or real</td>\n</tr>\n</tbody>\n</table>\n<h3>Query parameters</h3>\n<p>You can use query parameters with endpoints in the following components:</p>\n<table>\n<thead>\n<tr>\n<th>Component</th>\n<th>Query Parameter</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>isGov</code></td>\n<td>- Used to decide whether FSx storage is located in the governed location</td>\n</tr>\n<tr>\n<td><code>region</code></td>\n<td>- The API will be executed in the specified region</td>\n</tr>\n<tr>\n<td><code>workspace-id</code></td>\n<td>- The Cloud Manager workspace</td>\n</tr>\n</tbody>\n</table>\n<h4>Path parameters</h4>\n<p>You can use path parameters with endpoints.</p>\n<table>\n<thead>\n<tr>\n<th>Component</th>\n<th>Query Parameter</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>account-id</code></td>\n<td>Tenancy account ID for this API</td>\n</tr>\n<tr>\n<td><code>workingEnvironmentId</code></td>\n<td>FSx working environment ID used to execute this API</td>\n</tr>\n</tbody>\n</table>\n<h3>Response headers</h3>\n<p>This API uses the standard HTTP response headers common with all Cloud Manager APIs. See <a href=\"https://docs.netapp.com/us-en/cloud-manager-automation/platform/rest_implementation.html\">REST implementation</a> for more information.</p>\n<h3>HTTP status codes</h3>\n<table>\n<thead>\n<tr>\n<th>HTTP Status Code</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>200</code></td>\n<td>OK: Returned for successful operation completion</td>\n</tr>\n<tr>\n<td><code>400</code></td>\n<td>Bad Request: Returned if the input is malformed and could not be parsed</td>\n</tr>\n<tr>\n<td><code>401</code></td>\n<td>Unauthorized: Returned if user authentication failed or the token has expired</td>\n</tr>\n<tr>\n<td><code>403</code></td>\n<td>Forbidden: Returned for authorization errors depending on the resource and token</td>\n</tr>\n<tr>\n<td><code>404</code></td>\n<td>Not Found: Returned if the requested resource could not be found</td>\n</tr>\n<tr>\n<td><code>500</code></td>\n<td>Processing Error: Returned if an error occurs on the server while processing the API call</td>\n</tr>\n</tbody>\n</table>\n</details>\n<hr />\n   <details>\n<summary>Error handling</summary>\n<p>There are three processes involved with error handling and processing:</p>\n<ul>\n<li>The error is logged for supportability</li>\n<li>The error is returned to the caller for specific handling</li>\n<li>The database connection is rolled back</li>\n</ul>\n</details>\n<hr />\n   <details>\n<summary>cURL examples</summary>\n<h3>Retrieve FSx working environments for a specified account ID</h3>\n<p>This cURL example retrieves FSx working environments for a specified account ID.</p>\n<pre><code class=\"language-bash\">curl -X GET &quot;https://staging.cloudmanager.cloud.netapp.com/fsx-ontap/working-environments/&lt;accountId&gt;&quot;\n -H  &quot;accept: application/json&quot; -H  &quot;authorization: &lt;user token&gt;&quot;\n</code></pre>\n</details>\n<hr />\n   <br><br>",
       "version":"1.0",
       "contact":{
 

fsx/sidebar.yml

@@ -1,3 +1,3 @@
 section: fsx
-title: Amazon FSx for ONTAP service
+title: Amazon FSx for NetApp ONTAP 
 generate: fsx