apigateway_import_documentation_parts

Imports documentation parts
See <a href="https://paws-r.github.io/docs/apigateway/import_documentation_parts.html">https://paws-r.github.io/docs/apigateway/import_documentation_parts.html</a> for full documentation.

internal

Interface to 'Amazon Web Services' networking and content
delivery services, including 'Route 53' Domain Name System service,
'CloudFront' content delivery, load balancing, and more
<https://aws.amazon.com/>.

Dyfan Jones

paws.networking

'Amazon Web Services' Networking & Content Delivery Services

David Kretch

Adam Banker

Amazon.com, Inc. 

apigateway_import_documentation_parts function

<dl><dt>restApiId</dt>
<dd>[required] The string identifier of the associated RestApi.</dd>
<dt>mode</dt>
<dd>A query parameter to indicate whether to overwrite (<code>OVERWRITE</code>) any
existing DocumentationParts definition or to merge (<code>MERGE</code>) the new
definition into the existing one. The default value is <code>MERGE</code>.</dd>
<dt>failOnWarnings</dt>
<dd>A query parameter to specify whether to rollback the documentation
importation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The
default value is <code>false</code>.</dd>
<dt>body</dt>
<dd>[required] Raw byte array representing the to-be-imported documentation parts. To
import from an OpenAPI file, this is a JSON object.</dd></dl>

Arguments

Imports documentation parts
See <a href='https://paws-r.github.io/docs/apigateway/import_documentation_parts.html'>https://paws-r.github.io/docs/apigateway/import_documentation_parts.html</a> for full documentation.

Imports documentation parts — apigateway_import_documentation_parts

<dl>

<dt>restApiId</dt>
<dd>[required] The string identifier of the associated RestApi.</dd>


<dt>mode</dt>
<dd>A query parameter to indicate whether to overwrite (<code>OVERWRITE</code>) any
existing DocumentationParts definition or to merge (<code>MERGE</code>) the new
definition into the existing one. The default value is <code>MERGE</code>.</dd>


<dt>failOnWarnings</dt>
<dd>A query parameter to specify whether to rollback the documentation
importation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The
default value is <code>false</code>.</dd>


<dt>body</dt>
<dd>[required] Raw byte array representing the to-be-imported documentation parts. To
import from an OpenAPI file, this is a JSON object.</dd>

</dl>

Get 50% off unlimited learning

apigateway_import_documentation_parts: Imports documentation parts

Description

Usage

Arguments