1
0
mirror of synced 2025-12-25 02:09:19 -05:00

Hook-up MigrationHandler API (#1587)

This commit is contained in:
Christophe Duong
2021-01-11 14:15:06 +01:00
committed by GitHub
parent a7fd60c944
commit fe1fa17fbb
6 changed files with 190 additions and 10 deletions

View File

@@ -232,6 +232,11 @@ font-style: italic;
<ul>
<li><a href="#getDebuggingInfo"><code><span class="http-method">get</span> /v1/debug</code></a></li>
</ul>
<h4><a href="#Deployment">Deployment</a></h4>
<ul>
<li><a href="#exportArchive"><code><span class="http-method">post</span> /v1/deployment/export</code></a></li>
<li><a href="#importArchive"><code><span class="http-method">post</span> /v1/deployment/import</code></a></li>
</ul>
<h4><a href="#Destination">Destination</a></h4>
<ul>
<li><a href="#checkConnectionToDestination"><code><span class="http-method">post</span> /v1/destinations/check_connection</code></a></li>
@@ -1015,6 +1020,94 @@ font-style: italic;
<a href="#"></a>
</div> <!-- method -->
<hr/>
<h1><a name="Deployment">Deployment</a></h1>
<div class="method"><a name="exportArchive"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/deployment/export</code></pre></div>
<div class="method-summary">Export Airbyte Configuration and Data Archive (<span class="nickname">exportArchive</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Return type</h3>
<div class="return-type">
File
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/x-gzip</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Successful operation
<a href="#File">File</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="importArchive"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /v1/deployment/import</code></pre></div>
<div class="method-summary">Import Airbyte Configuration and Data Archive (<span class="nickname">importArchive</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/x-gzip</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body <a href="#file">file</a> (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#ImportRead">ImportRead</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"status" : "succeeded"
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Successful operation
<a href="#ImportRead">ImportRead</a>
</div> <!-- method -->
<hr/>
<h1><a name="Destination">Destination</a></h1>
<div class="method"><a name="checkConnectionToDestination"/>
<div class="method-path">
@@ -3751,6 +3844,7 @@ font-style: italic;
<li><a href="#DestinationRecreate"><code>DestinationRecreate</code> - </a></li>
<li><a href="#DestinationUpdate"><code>DestinationUpdate</code> - </a></li>
<li><a href="#HealthCheckRead"><code>HealthCheckRead</code> - </a></li>
<li><a href="#ImportRead"><code>ImportRead</code> - </a></li>
<li><a href="#JobConfigType"><code>JobConfigType</code> - </a></li>
<li><a href="#JobIdRequestBody"><code>JobIdRequestBody</code> - </a></li>
<li><a href="#JobInfoRead"><code>JobInfoRead</code> - </a></li>
@@ -4028,6 +4122,15 @@ font-style: italic;
<div class="param">db </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="ImportRead"><code>ImportRead</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">succeeded</div><div class="param-enum">failed</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="JobConfigType"><code>JobConfigType</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>