Skip to content

Commit 63c533b

Browse files
bdeneuxbdeneux
committed
feat(docs): publish docs
1 parent 6a43254 commit 63c533b

17 files changed

+441
-0
lines changed

‎docs/README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# README
2+
3+
## Top-level Schemas
4+
5+
* [cw-template](./cw-template.md "CW TemplateBase smart contract to start coding into the blockchain 🚀") – `-`
6+
7+
## Other Schemas
8+
9+
### Objects
10+
11+
* [GetCount](./cw-template-querymsg-oneof-getcount.md "GetCount returns the current count as a json-encoded number") – `undefined#/query/oneOf/0`
12+
13+
* [GetCountResponse](./cw-template-responses-getcountresponse.md "We define a custom struct for each query response") – `undefined#/responses/get_count`
14+
15+
* [InstantiateMsg](./cw-template-instantiatemsg.md "Instantiate CW-Template") – `undefined#/instantiate`
16+
17+
* [Untitled object in cw-template](./cw-template-executemsg-oneof-0.md) – `undefined#/execute/oneOf/0`
18+
19+
* [Untitled object in cw-template](./cw-template-executemsg-oneof-0-properties-increment.md) – `undefined#/execute/oneOf/0/properties/increment`
20+
21+
* [Untitled object in cw-template](./cw-template-executemsg-oneof-1.md) – `undefined#/execute/oneOf/1`
22+
23+
* [Untitled object in cw-template](./cw-template-executemsg-oneof-1-properties-reset.md) – `undefined#/execute/oneOf/1/properties/reset`
24+
25+
* [Untitled object in cw-template](./cw-template-querymsg-oneof-getcount-properties-get_count.md) – `undefined#/query/oneOf/0/properties/get_count`
26+
27+
### Arrays
28+
29+
30+
31+
## Version Note
32+
33+
The schemas linked above follow the JSON Schema Spec version: `http://json-schema.org/draft-07/schema#`

‎docs/cw-template-executemsg-oneof-0-properties-increment.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Untitled object in cw-template Schema
2+
3+
```txt
4+
undefined#/execute/oneOf/0/properties/increment
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## increment Type
14+
15+
`object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))

‎docs/cw-template-executemsg-oneof-0.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Untitled object in cw-template Schema
2+
3+
```txt
4+
undefined#/execute/oneOf/0
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## 0 Type
14+
15+
`object` ([Details](cw-template-executemsg-oneof-0.md))
16+
17+
# 0 Properties
18+
19+
| Property | Type | Required | Nullable | Defined by |
20+
| :---------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------- |
21+
| [increment](#increment) | `object` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-0-properties-increment.md "undefined#/execute/oneOf/0/properties/increment") |
22+
23+
## increment
24+
25+
26+
27+
`increment`
28+
29+
* is required
30+
31+
* Type: `object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))
32+
33+
* cannot be null
34+
35+
* defined in: [cw-template](cw-template-executemsg-oneof-0-properties-increment.md "undefined#/execute/oneOf/0/properties/increment")
36+
37+
### increment Type
38+
39+
`object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))

‎docs/cw-template-executemsg-oneof-1-properties-reset-properties-count.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Untitled integer in cw-template Schema
2+
3+
```txt
4+
undefined#/execute/oneOf/1/properties/reset/properties/count
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## count Type
14+
15+
`integer`
16+
17+
## count Constraints
18+
19+
**unknown format**: the value of this string must follow the format: `int32`

‎docs/cw-template-executemsg-oneof-1-properties-reset.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Untitled object in cw-template Schema
2+
3+
```txt
4+
undefined#/execute/oneOf/1/properties/reset
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## reset Type
14+
15+
`object` ([Details](cw-template-executemsg-oneof-1-properties-reset.md))
16+
17+
# reset Properties
18+
19+
| Property | Type | Required | Nullable | Defined by |
20+
| :-------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ |
21+
| [count](#count) | `integer` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-1-properties-reset-properties-count.md "undefined#/execute/oneOf/1/properties/reset/properties/count") |
22+
23+
## count
24+
25+
26+
27+
`count`
28+
29+
* is required
30+
31+
* Type: `integer`
32+
33+
* cannot be null
34+
35+
* defined in: [cw-template](cw-template-executemsg-oneof-1-properties-reset-properties-count.md "undefined#/execute/oneOf/1/properties/reset/properties/count")
36+
37+
### count Type
38+
39+
`integer`
40+
41+
### count Constraints
42+
43+
**unknown format**: the value of this string must follow the format: `int32`

‎docs/cw-template-executemsg-oneof-1.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Untitled object in cw-template Schema
2+
3+
```txt
4+
undefined#/execute/oneOf/1
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## 1 Type
14+
15+
`object` ([Details](cw-template-executemsg-oneof-1.md))
16+
17+
# 1 Properties
18+
19+
| Property | Type | Required | Nullable | Defined by |
20+
| :-------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------- |
21+
| [reset](#reset) | `object` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-1-properties-reset.md "undefined#/execute/oneOf/1/properties/reset") |
22+
23+
## reset
24+
25+
26+
27+
`reset`
28+
29+
* is required
30+
31+
* Type: `object` ([Details](cw-template-executemsg-oneof-1-properties-reset.md))
32+
33+
* cannot be null
34+
35+
* defined in: [cw-template](cw-template-executemsg-oneof-1-properties-reset.md "undefined#/execute/oneOf/1/properties/reset")
36+
37+
### reset Type
38+
39+
`object` ([Details](cw-template-executemsg-oneof-1-properties-reset.md))

‎docs/cw-template-executemsg.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# ExecuteMsg Schema
2+
3+
```txt
4+
undefined#/execute
5+
```
6+
7+
Execute messages
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## execute Type
14+
15+
merged type ([ExecuteMsg](cw-template-executemsg.md))
16+
17+
one (and only one) of
18+
19+
* [Untitled object in cw-template](cw-template-executemsg-oneof-0.md "check type definition")
20+
21+
* [Untitled object in cw-template](cw-template-executemsg-oneof-1.md "check type definition")

‎docs/cw-template-instantiatemsg-properties-count.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Untitled integer in cw-template Schema
2+
3+
```txt
4+
undefined#/instantiate/properties/count
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## count Type
14+
15+
`integer`
16+
17+
## count Constraints
18+
19+
**unknown format**: the value of this string must follow the format: `int32`

‎docs/cw-template-instantiatemsg.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# InstantiateMsg Schema
2+
3+
```txt
4+
undefined#/instantiate
5+
```
6+
7+
Instantiate CW-Template
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## instantiate Type
14+
15+
`object` ([InstantiateMsg](cw-template-instantiatemsg.md))
16+
17+
# instantiate Properties
18+
19+
| Property | Type | Required | Nullable | Defined by |
20+
| :-------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------ |
21+
| [count](#count) | `integer` | Required | cannot be null | [cw-template](cw-template-instantiatemsg-properties-count.md "undefined#/instantiate/properties/count") |
22+
23+
## count
24+
25+
26+
27+
`count`
28+
29+
* is required
30+
31+
* Type: `integer`
32+
33+
* cannot be null
34+
35+
* defined in: [cw-template](cw-template-instantiatemsg-properties-count.md "undefined#/instantiate/properties/count")
36+
37+
### count Type
38+
39+
`integer`
40+
41+
### count Constraints
42+
43+
**unknown format**: the value of this string must follow the format: `int32`

‎docs/cw-template-querymsg-oneof-getcount-properties-get_count.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Untitled object in cw-template Schema
2+
3+
```txt
4+
undefined#/query/oneOf/0/properties/get_count
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## get\_count Type
14+
15+
`object` ([Details](cw-template-querymsg-oneof-getcount-properties-get_count.md))

‎docs/cw-template-querymsg-oneof-getcount.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# GetCount Schema
2+
3+
```txt
4+
undefined#/query/oneOf/0
5+
```
6+
7+
GetCount returns the current count as a json-encoded number
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## 0 Type
14+
15+
`object` ([GetCount](cw-template-querymsg-oneof-getcount.md))
16+
17+
# 0 Properties
18+
19+
| Property | Type | Required | Nullable | Defined by |
20+
| :----------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------- |
21+
| [get\_count](#get_count) | `object` | Required | cannot be null | [cw-template](cw-template-querymsg-oneof-getcount-properties-get_count.md "undefined#/query/oneOf/0/properties/get_count") |
22+
23+
## get\_count
24+
25+
26+
27+
`get_count`
28+
29+
* is required
30+
31+
* Type: `object` ([Details](cw-template-querymsg-oneof-getcount-properties-get_count.md))
32+
33+
* cannot be null
34+
35+
* defined in: [cw-template](cw-template-querymsg-oneof-getcount-properties-get_count.md "undefined#/query/oneOf/0/properties/get_count")
36+
37+
### get\_count Type
38+
39+
`object` ([Details](cw-template-querymsg-oneof-getcount-properties-get_count.md))

‎docs/cw-template-querymsg.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# QueryMsg Schema
2+
3+
```txt
4+
undefined#/query
5+
```
6+
7+
Query messages
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## query Type
14+
15+
merged type ([QueryMsg](cw-template-querymsg.md))
16+
17+
one (and only one) of
18+
19+
* [GetCount](cw-template-querymsg-oneof-getcount.md "check type definition")

‎docs/cw-template-responses-getcountresponse-properties-count.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Untitled integer in cw-template Schema
2+
3+
```txt
4+
undefined#/responses/get_count/properties/count
5+
```
6+
7+
8+
9+
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10+
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
11+
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |
12+
13+
## count Type
14+
15+
`integer`
16+
17+
## count Constraints
18+
19+
**unknown format**: the value of this string must follow the format: `int32`

0 commit comments

Comments
 (0)