Skip to content

Commit

Permalink
feat(docs): publish docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@bdeneux
bdeneux committed Oct 19, 2022
1 parent 6a43254 commit 63c533b
Show file tree
Hide file tree
Showing 17 changed files with 441 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# README

## Top-level Schemas

* [cw-template](./cw-template.md "CW TemplateBase smart contract to start coding into the blockchain 🚀") – `-`

## Other Schemas

### Objects

* [GetCount](./cw-template-querymsg-oneof-getcount.md "GetCount returns the current count as a json-encoded number") – `undefined#/query/oneOf/0`

* [GetCountResponse](./cw-template-responses-getcountresponse.md "We define a custom struct for each query response") – `undefined#/responses/get_count`

* [InstantiateMsg](./cw-template-instantiatemsg.md "Instantiate CW-Template") – `undefined#/instantiate`

* [Untitled object in cw-template](./cw-template-executemsg-oneof-0.md) – `undefined#/execute/oneOf/0`

* [Untitled object in cw-template](./cw-template-executemsg-oneof-0-properties-increment.md) – `undefined#/execute/oneOf/0/properties/increment`

* [Untitled object in cw-template](./cw-template-executemsg-oneof-1.md) – `undefined#/execute/oneOf/1`

* [Untitled object in cw-template](./cw-template-executemsg-oneof-1-properties-reset.md) – `undefined#/execute/oneOf/1/properties/reset`

* [Untitled object in cw-template](./cw-template-querymsg-oneof-getcount-properties-get_count.md) – `undefined#/query/oneOf/0/properties/get_count`

### Arrays



## Version Note

The schemas linked above follow the JSON Schema Spec version: `http://json-schema.org/draft-07/schema#`
15 changes: 15 additions & 0 deletions docs/cw-template-executemsg-oneof-0-properties-increment.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled object in cw-template Schema

```txt
undefined#/execute/oneOf/0/properties/increment
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## increment Type

`object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))
39 changes: 39 additions & 0 deletions docs/cw-template-executemsg-oneof-0.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Untitled object in cw-template Schema

```txt
undefined#/execute/oneOf/0
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## 0 Type

`object` ([Details](cw-template-executemsg-oneof-0.md))

# 0 Properties

| Property | Type | Required | Nullable | Defined by |
| :---------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------- |
| [increment](#increment) | `object` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-0-properties-increment.md "undefined#/execute/oneOf/0/properties/increment") |

## increment



`increment`

* is required

* Type: `object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))

* cannot be null

* defined in: [cw-template](cw-template-executemsg-oneof-0-properties-increment.md "undefined#/execute/oneOf/0/properties/increment")

### increment Type

`object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))
19 changes: 19 additions & 0 deletions docs/cw-template-executemsg-oneof-1-properties-reset-properties-count.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Untitled integer in cw-template Schema

```txt
undefined#/execute/oneOf/1/properties/reset/properties/count
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## count Type

`integer`

## count Constraints

**unknown format**: the value of this string must follow the format: `int32`
43 changes: 43 additions & 0 deletions docs/cw-template-executemsg-oneof-1-properties-reset.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Untitled object in cw-template Schema

```txt
undefined#/execute/oneOf/1/properties/reset
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## reset Type

`object` ([Details](cw-template-executemsg-oneof-1-properties-reset.md))

# reset Properties

| Property | Type | Required | Nullable | Defined by |
| :-------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ |
| [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") |

## count



`count`

* is required

* Type: `integer`

* cannot be null

* defined in: [cw-template](cw-template-executemsg-oneof-1-properties-reset-properties-count.md "undefined#/execute/oneOf/1/properties/reset/properties/count")

### count Type

`integer`

### count Constraints

**unknown format**: the value of this string must follow the format: `int32`
39 changes: 39 additions & 0 deletions docs/cw-template-executemsg-oneof-1.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Untitled object in cw-template Schema

```txt
undefined#/execute/oneOf/1
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## 1 Type

`object` ([Details](cw-template-executemsg-oneof-1.md))

# 1 Properties

| Property | Type | Required | Nullable | Defined by |
| :-------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------- |
| [reset](#reset) | `object` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-1-properties-reset.md "undefined#/execute/oneOf/1/properties/reset") |

## reset



`reset`

* is required

* Type: `object` ([Details](cw-template-executemsg-oneof-1-properties-reset.md))

* cannot be null

* defined in: [cw-template](cw-template-executemsg-oneof-1-properties-reset.md "undefined#/execute/oneOf/1/properties/reset")

### reset Type

`object` ([Details](cw-template-executemsg-oneof-1-properties-reset.md))
21 changes: 21 additions & 0 deletions docs/cw-template-executemsg.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# ExecuteMsg Schema

```txt
undefined#/execute
```

Execute messages

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## execute Type

merged type ([ExecuteMsg](cw-template-executemsg.md))

one (and only one) of

* [Untitled object in cw-template](cw-template-executemsg-oneof-0.md "check type definition")

* [Untitled object in cw-template](cw-template-executemsg-oneof-1.md "check type definition")
19 changes: 19 additions & 0 deletions docs/cw-template-instantiatemsg-properties-count.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Untitled integer in cw-template Schema

```txt
undefined#/instantiate/properties/count
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## count Type

`integer`

## count Constraints

**unknown format**: the value of this string must follow the format: `int32`
43 changes: 43 additions & 0 deletions docs/cw-template-instantiatemsg.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# InstantiateMsg Schema

```txt
undefined#/instantiate
```

Instantiate CW-Template

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## instantiate Type

`object` ([InstantiateMsg](cw-template-instantiatemsg.md))

# instantiate Properties

| Property | Type | Required | Nullable | Defined by |
| :-------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------ |
| [count](#count) | `integer` | Required | cannot be null | [cw-template](cw-template-instantiatemsg-properties-count.md "undefined#/instantiate/properties/count") |

## count



`count`

* is required

* Type: `integer`

* cannot be null

* defined in: [cw-template](cw-template-instantiatemsg-properties-count.md "undefined#/instantiate/properties/count")

### count Type

`integer`

### count Constraints

**unknown format**: the value of this string must follow the format: `int32`
15 changes: 15 additions & 0 deletions docs/cw-template-querymsg-oneof-getcount-properties-get_count.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Untitled object in cw-template Schema

```txt
undefined#/query/oneOf/0/properties/get_count
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## get\_count Type

`object` ([Details](cw-template-querymsg-oneof-getcount-properties-get_count.md))
39 changes: 39 additions & 0 deletions docs/cw-template-querymsg-oneof-getcount.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# GetCount Schema

```txt
undefined#/query/oneOf/0
```

GetCount returns the current count as a json-encoded number

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## 0 Type

`object` ([GetCount](cw-template-querymsg-oneof-getcount.md))

# 0 Properties

| Property | Type | Required | Nullable | Defined by |
| :----------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------- |
| [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") |

## get\_count



`get_count`

* is required

* Type: `object` ([Details](cw-template-querymsg-oneof-getcount-properties-get_count.md))

* cannot be null

* defined in: [cw-template](cw-template-querymsg-oneof-getcount-properties-get_count.md "undefined#/query/oneOf/0/properties/get_count")

### get\_count Type

`object` ([Details](cw-template-querymsg-oneof-getcount-properties-get_count.md))
19 changes: 19 additions & 0 deletions docs/cw-template-querymsg.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# QueryMsg Schema

```txt
undefined#/query
```

Query messages

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## query Type

merged type ([QueryMsg](cw-template-querymsg.md))

one (and only one) of

* [GetCount](cw-template-querymsg-oneof-getcount.md "check type definition")
19 changes: 19 additions & 0 deletions docs/cw-template-responses-getcountresponse-properties-count.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Untitled integer in cw-template Schema

```txt
undefined#/responses/get_count/properties/count
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## count Type

`integer`

## count Constraints

**unknown format**: the value of this string must follow the format: `int32`
Loading

0 comments on commit 63c533b

Please sign in to comment.