-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update generated docs for the test schema
- Loading branch information
Showing
7 changed files
with
1,213 additions
and
0 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
205 changes: 205 additions & 0 deletions
205
pkg/codegen/testing/test/testdata/simplified-invokes/docs/getarchive/_index.md
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,205 @@ | ||
|
||
--- | ||
title: "GetArchive" | ||
title_tag: "std.GetArchive" | ||
meta_desc: "Documentation for the std.GetArchive function with examples, input properties, output properties, and supporting types." | ||
layout: api | ||
no_edit_this_page: true | ||
--- | ||
|
||
|
||
|
||
<!-- WARNING: this file was generated by test. --> | ||
<!-- Do not edit by hand unless you're certain you know what you are doing! --> | ||
|
||
|
||
|
||
|
||
## Using GetArchive {#using} | ||
|
||
Two invocation forms are available. The direct form accepts plain | ||
arguments and either blocks until the result value is available, or | ||
returns a Promise-wrapped result. The output form accepts | ||
Input-wrapped arguments and returns an Output-wrapped result. | ||
|
||
<div> | ||
<pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser> | ||
</div> | ||
|
||
|
||
<div> | ||
<pulumi-choosable type="language" values="javascript,typescript"> | ||
<div class="highlight" | ||
><pre class="chroma"><code class="language-typescript" data-lang="typescript" | ||
><span class="k">function </span>getArchive<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">GetArchiveArgs</span><span class="p">,</span> <span class="nx">opts</span><span class="p">?:</span> <span class="nx"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#InvokeOptions">InvokeOptions</a></span><span class="p">): Promise<<span class="nx"><a href="#result">GetArchiveResult</a></span>></span | ||
><span class="k"> | ||
function </span>getArchiveOutput<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">GetArchiveOutputArgs</span><span class="p">,</span> <span class="nx">opts</span><span class="p">?:</span> <span class="nx"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#InvokeOptions">InvokeOptions</a></span><span class="p">): Output<<span class="nx"><a href="#result">GetArchiveResult</a></span>></span | ||
></code></pre></div> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
<div> | ||
<pulumi-choosable type="language" values="python"> | ||
<div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python" | ||
><span class="k">def </span>get_archive<span class="p">(</span><span class="nx">a</span><span class="p">:</span> <span class="nx">Optional[float]</span> = None<span class="p">,</span> | ||
<span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.InvokeOptions">Optional[InvokeOptions]</a></span> = None<span class="p">) -></span> <span>GetArchiveResult</span | ||
><span class="k"> | ||
def </span>get_archive_output<span class="p">(</span><span class="nx">a</span><span class="p">:</span> <span class="nx">Optional[pulumi.Input[float]]</span> = None<span class="p">,</span> | ||
<span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.InvokeOptions">Optional[InvokeOptions]</a></span> = None<span class="p">) -></span> <span>Output[GetArchiveResult]</span | ||
></code></pre></div> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
<div> | ||
<pulumi-choosable type="language" values="go"> | ||
<div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go" | ||
><span class="k">func </span>GetArchive<span class="p">(</span><span class="nx">ctx</span><span class="p"> *</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span><span class="p">,</span> <span class="nx">args</span><span class="p"> *</span><span class="nx">GetArchiveArgs</span><span class="p">,</span> <span class="nx">opts</span><span class="p"> ...</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#InvokeOption">InvokeOption</a></span><span class="p">) (*<span class="nx"><a href="#result">GetArchiveResult</a></span>, error)</span | ||
><span class="k"> | ||
func </span>GetArchiveOutput<span class="p">(</span><span class="nx">ctx</span><span class="p"> *</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span><span class="p">,</span> <span class="nx">args</span><span class="p"> *</span><span class="nx">GetArchiveOutputArgs</span><span class="p">,</span> <span class="nx">opts</span><span class="p"> ...</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#InvokeOption">InvokeOption</a></span><span class="p">) GetArchiveResultOutput</span | ||
></code></pre></div> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
|
||
<div> | ||
<pulumi-choosable type="language" values="csharp"> | ||
<div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public static class </span><span class="nx">GetArchive </span><span class="p"> | ||
{</span><span class="k"> | ||
public static </span>Task<<span class="nx"><a href="#result">GetArchiveResult</a></span>> <span class="p">InvokeAsync(</span><span class="nx">GetArchiveArgs</span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.InvokeOptions.html">InvokeOptions</a></span><span class="p">? </span><span class="nx">opts = null<span class="p">)</span><span class="k"> | ||
public static </span>Output<<span class="nx"><a href="#result">GetArchiveResult</a></span>> <span class="p">Invoke(</span><span class="nx">GetArchiveInvokeArgs</span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.InvokeOptions.html">InvokeOptions</a></span><span class="p">? </span><span class="nx">opts = null<span class="p">)</span><span class="p"> | ||
}</span></code></pre></div> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
|
||
<div> | ||
<pulumi-choosable type="language" values="java"> | ||
<div class="highlight"><pre class="chroma"><code class="language-java" data-lang="java"><span class="k">public static CompletableFuture<<span class="nx"><a href="#result">GetArchiveResult</a></span>> </span>getArchive<span class="p">(</span><span class="nx">GetArchiveArgs</span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx">InvokeOptions</span><span class="p"> </span><span class="nx">options<span class="p">)</span> | ||
<span class="c">// Output-based functions aren't available in Java yet</span> | ||
</code></pre></div> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
|
||
<div> | ||
<pulumi-choosable type="language" values="yaml"> | ||
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="k">fn::invoke:</span> | ||
<span class="k"> function:</span> std:GetArchive | ||
<span class="k"> arguments:</span> | ||
<span class="c"> # arguments dictionary</span></code></pre></div> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
|
||
|
||
The following arguments are supported: | ||
|
||
|
||
<div> | ||
<pulumi-choosable type="language" values="csharp"> | ||
<dl class="resources-properties"><dt class="property-optional" | ||
title="Optional"> | ||
<span id="a_csharp"> | ||
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_csharp" style="color: inherit; text-decoration: inherit;">A</a> | ||
</span> | ||
<span class="property-indicator"></span> | ||
<span class="property-type">double</span> | ||
</dt> | ||
<dd></dd></dl> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
<div> | ||
<pulumi-choosable type="language" values="go"> | ||
<dl class="resources-properties"><dt class="property-optional" | ||
title="Optional"> | ||
<span id="a_go"> | ||
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_go" style="color: inherit; text-decoration: inherit;">A</a> | ||
</span> | ||
<span class="property-indicator"></span> | ||
<span class="property-type">float64</span> | ||
</dt> | ||
<dd></dd></dl> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
<div> | ||
<pulumi-choosable type="language" values="java"> | ||
<dl class="resources-properties"><dt class="property-optional" | ||
title="Optional"> | ||
<span id="a_java"> | ||
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_java" style="color: inherit; text-decoration: inherit;">a</a> | ||
</span> | ||
<span class="property-indicator"></span> | ||
<span class="property-type">Double</span> | ||
</dt> | ||
<dd></dd></dl> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
<div> | ||
<pulumi-choosable type="language" values="javascript,typescript"> | ||
<dl class="resources-properties"><dt class="property-optional" | ||
title="Optional"> | ||
<span id="a_nodejs"> | ||
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_nodejs" style="color: inherit; text-decoration: inherit;">a</a> | ||
</span> | ||
<span class="property-indicator"></span> | ||
<span class="property-type">number</span> | ||
</dt> | ||
<dd></dd></dl> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
<div> | ||
<pulumi-choosable type="language" values="python"> | ||
<dl class="resources-properties"><dt class="property-optional" | ||
title="Optional"> | ||
<span id="a_python"> | ||
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_python" style="color: inherit; text-decoration: inherit;">a</a> | ||
</span> | ||
<span class="property-indicator"></span> | ||
<span class="property-type">float</span> | ||
</dt> | ||
<dd></dd></dl> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
<div> | ||
<pulumi-choosable type="language" values="yaml"> | ||
<dl class="resources-properties"><dt class="property-optional" | ||
title="Optional"> | ||
<span id="a_yaml"> | ||
<a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_yaml" style="color: inherit; text-decoration: inherit;">a</a> | ||
</span> | ||
<span class="property-indicator"></span> | ||
<span class="property-type">Number</span> | ||
</dt> | ||
<dd></dd></dl> | ||
</pulumi-choosable> | ||
</div> | ||
|
||
|
||
|
||
|
||
## GetArchive Result {#result} | ||
|
||
The following output properties are available: | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h2 id="package-details">Package Details</h2> | ||
<dl class="package-details"> | ||
<dt>Repository</dt> | ||
<dd><a href="https://github.com/pulumi/pulumi-std">https://github.com/pulumi/pulumi-std</a></dd> | ||
<dt>License</dt> | ||
<dd></dd> | ||
</dl> | ||
|
Oops, something went wrong.