Skip to content

Commit

Permalink
2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@dkackman
dkackman committed Oct 6, 2023
1 parent 4140e57 commit 66472de
Show file tree
Hide file tree
Showing 14 changed files with 5,088 additions and 3,640 deletions.
826 changes: 426 additions & 400 deletions docs/redoc/crawler.html
View file

Large diffs are not rendered by default.

1,164 changes: 650 additions & 514 deletions docs/redoc/daemon.html
View file

Large diffs are not rendered by default.

1,094 changes: 604 additions & 490 deletions docs/redoc/data_layer.html
View file

Large diffs are not rendered by default.

965 changes: 516 additions & 449 deletions docs/redoc/farmer.html
View file

Large diffs are not rendered by default.

1,147 changes: 636 additions & 511 deletions docs/redoc/full_node.html
View file

Large diffs are not rendered by default.

883 changes: 465 additions & 418 deletions docs/redoc/harvester.html
View file

Large diffs are not rendered by default.

2,187 changes: 1,342 additions & 845 deletions docs/redoc/wallet.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/static/crawler.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -896,7 +896,7 @@ <h1>Chia RPC</h1>
<div id="header">
<div id="api-_">
<h2 id="welcome-to-apidoc">API Documentation</h2>
<div class="app-desc">Version: 2.0.0</div>
<div class="app-desc">Version: 2.1.0</div>
<hr>
<div>The Chia node and services come with a JSON RPC API server that allows you to access information and control the services. These are accessible via HTTPS, WebSockets, or via client SDKs. The ports can be configured in <code>~/.chia/mainnet/config/config.yaml</code>. The RPC ports should not be exposed to the internet. TLS certificates are used to secure the communication <a href="https://github.com/dkackman/chia-api/wiki/Mutual-TLS">using mutualTLS</a>.
The crawler uses port 8561 by default.</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/static/daemon.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1021,8 +1021,8 @@
defs["k_size"] = {
"type" : "integer",
"description" : "Defines the size of a plot. 25 is used for testing only. https://github.com/Chia-Network/chia-blockchain/wiki/k-sizes",
"default" : 32,
"enum" : [ 25, 32, 33, 34, 35 ]
"enum" : [ 25, 32, 33, 34, 35 ],
"default" : 32
};
defs["key_data"] = {
"type" : "object",
Expand Down Expand Up @@ -1524,7 +1524,7 @@ <h1>Chia RPC</h1>
<div id="header">
<div id="api-_">
<h2 id="welcome-to-apidoc">API Documentation</h2>
<div class="app-desc">Version: 2.0.0</div>
<div class="app-desc">Version: 2.1.0</div>
<hr>
<div>The Chia node and services come with a JSON RPC API server that allows you to access information and control the services. These are accessible via HTTPS, WebSockets, or via client SDKs. The ports can be configured in <code>~/.chia/mainnet/config/config.yaml</code>. The RPC ports should not be exposed to the internet. TLS certificates are used to secure the communication <a href="https://github.com/dkackman/chia-api/wiki/Mutual-TLS">using mutualTLS</a>.
The daemon uses port 55400 by default.</div>
Expand Down
140 changes: 139 additions & 1 deletion docs/static/data_layer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1940,6 +1940,10 @@
"id" : {
"type" : "string",
"format" : "bytes32"
},
"retain" : {
"type" : "boolean",
"default" : false
}
}
};
Expand All @@ -1956,6 +1960,16 @@
"default" : 0
}
}
};
defs["wallet_log_in_body"] = {
"required" : [ "fingerprint" ],
"type" : "object",
"properties" : {
"fingerprint" : {
"type" : "integer",
"format" : "uint32"
}
}
};
</script>

Expand Down Expand Up @@ -2021,6 +2035,9 @@
<li class="nav-item" data-group="DataLayer" data-name="insert">
<a class="nav-link link-secondary" href="#api-DataLayer-insert">insert</a>
</li>
<li class="nav-item" data-group="DataLayer" data-name="walletLogIn">
<a class="nav-link link-secondary" href="#api-DataLayer-walletLogIn">walletLogIn</a>
</li>
<li class="nav-header nav-item" data-group="Mirrors">
<a class="nav-link" href="#api-Mirrors">Mirrors</a>
</li>
Expand Down Expand Up @@ -2103,7 +2120,7 @@ <h1>Chia RPC</h1>
<div id="header">
<div id="api-_">
<h2 id="welcome-to-apidoc">API Documentation</h2>
<div class="app-desc">Version: 2.0.0</div>
<div class="app-desc">Version: 2.1.0</div>
<hr>
<div>The Chia node and services come with a JSON RPC API server that allows you to access information and control the services. These are accessible via HTTPS, WebSockets, or via client SDKs. The ports can be configured in <code>~/.chia/mainnet/config/config.yaml</code>. The RPC ports should not be exposed to the internet. TLS certificates are used to secure the communication <a href="https://github.com/dkackman/chia-api/wiki/Mutual-TLS">using mutualTLS</a>.
The data layer uses port 8562 by default.</div>
Expand Down Expand Up @@ -4047,6 +4064,127 @@ <h3> Status: 200 - OK </h3>
</div>
</div>

</article>
</div>
<div id="api-DataLayer-walletLogIn">
<article id="api-DataLayer-walletLogIn-0" data-group="User" data-name="walletLogIn" data-version="0">
<div class="pull-left">
<h1>walletLogIn</h1>
<p>Logs into the wallet.</p>
</div>
<p class="marked">Logs into the wallet.</p>
<p class="http-method" data-type="post">post</p>
<pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/wallet_log_in</span></code></pre>

<h3>Usage</h3>
<div class="tab-content">
<div class="tab-pane active" id="examples-DataLayer-walletLogIn-0-curl">
<pre class="prettyprint"><code class="language-bsh">curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/wallet_log_in" \
-d "{}"</code></pre>
<h2>Parameters</h2>



<div class="methodsubtabletitle">Body parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">body <span style="color:red;">*</span></td>
<td>


<script>
$(document).ready(function() {
var schemaWrapper = {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/wallet_log_in_body"
}
}
},
"required" : true
};
var schema = schemaWrapper.content["application/json"].schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.components = {};
schemaWrapper.components.schemas = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}

var view = new JSONSchemaView(schema,2,{isBodyParam: true});
var result = $('#d2e199_walletLogIn_body');
result.empty();
result.append(view.render());
});
</script>
<div id="d2e199_walletLogIn_body"></div>
</td>
</tr>
</table>



<h2>Responses</h2>
<h3> Status: 200 - OK response without return values </h3>

<ul class="nav nav-tabs nav-tabs-examples" >
<li class="active">
<a data-toggle="tab" href="#responses-walletLogIn-200-schema">Schema</a>
</li>

</ul>

<div class="tab-content" style='margin-bottom: 10px;'>
<div class="tab-pane active" id="responses-walletLogIn-200-schema">
<div id='responses-walletLogIn-200-schema-200' style="padding: 30px; border-left: 1px solid #eee; border-right: 1px solid #eee; border-bottom: 1px solid #eee;">
<script>
$(document).ready(function() {
var schemaWrapper = {
"description" : "OK response without return values",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/apiResponse"
}
}
}
};
var schema = schemaWrapper.content["application/json"].schema;
if (schema.$ref != null) {
schema = defsParser.$refs.get(schema.$ref);
} else {
schemaWrapper.components = {};
schemaWrapper.components.schemas = Object.assign({}, defs);
$RefParser.dereference(schemaWrapper).catch(function(err) {
console.log(err);
});
}

//console.log(JSON.stringify(schema));
var view = new JSONSchemaView(schema, 3);
$('#responses-walletLogIn-200-schema-data').val(stringify(schema));
var result = $('#responses-walletLogIn-200-schema-200');
result.empty();
result.append(view.render());
});
</script>
</div>
<input id='responses-walletLogIn-200-schema-data' type='hidden' value=''></input>
</div>
</div>

</article>
</div>
</section>
Expand Down
2 changes: 1 addition & 1 deletion docs/static/farmer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1447,7 +1447,7 @@ <h1>Chia RPC</h1>
<div id="header">
<div id="api-_">
<h2 id="welcome-to-apidoc">API Documentation</h2>
<div class="app-desc">Version: 2.0.0</div>
<div class="app-desc">Version: 2.1.0</div>
<hr>
<div>The Chia node and services come with a JSON RPC API server that allows you to access information and control the services. These are accessible via HTTPS, WebSockets, or via client SDKs. The ports can be configured in <code>~/.chia/mainnet/config/config.yaml</code>. The RPC ports should not be exposed to the internet. TLS certificates are used to secure the communication <a href="https://github.com/dkackman/chia-api/wiki/Mutual-TLS">using mutualTLS</a>.
The farmer uses port 8559 by default.</div>
Expand Down
Loading

0 comments on commit 66472de

Please sign in to comment.