From 63c533bc5a9e21a0799d29f2f6492b3be7a6420f Mon Sep 17 00:00:00 2001 From: Benjamin DENEUX Date: Wed, 19 Oct 2022 16:11:37 +0200 Subject: [PATCH] feat(docs): publish docs --- docs/README.md | 33 ++++++++++++++ ...executemsg-oneof-0-properties-increment.md | 15 +++++++ docs/cw-template-executemsg-oneof-0.md | 39 +++++++++++++++++ ...eof-1-properties-reset-properties-count.md | 19 ++++++++ ...ate-executemsg-oneof-1-properties-reset.md | 43 +++++++++++++++++++ docs/cw-template-executemsg-oneof-1.md | 39 +++++++++++++++++ docs/cw-template-executemsg.md | 21 +++++++++ ...emplate-instantiatemsg-properties-count.md | 19 ++++++++ docs/cw-template-instantiatemsg.md | 43 +++++++++++++++++++ ...msg-oneof-getcount-properties-get_count.md | 15 +++++++ docs/cw-template-querymsg-oneof-getcount.md | 39 +++++++++++++++++ docs/cw-template-querymsg.md | 19 ++++++++ ...onses-getcountresponse-properties-count.md | 19 ++++++++ .../cw-template-responses-getcountresponse.md | 43 +++++++++++++++++++ docs/cw-template-responses.md | 15 +++++++ docs/cw-template.md | 19 ++++++++ docs/schema/cw-template.json | 1 + 17 files changed, 441 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/cw-template-executemsg-oneof-0-properties-increment.md create mode 100644 docs/cw-template-executemsg-oneof-0.md create mode 100644 docs/cw-template-executemsg-oneof-1-properties-reset-properties-count.md create mode 100644 docs/cw-template-executemsg-oneof-1-properties-reset.md create mode 100644 docs/cw-template-executemsg-oneof-1.md create mode 100644 docs/cw-template-executemsg.md create mode 100644 docs/cw-template-instantiatemsg-properties-count.md create mode 100644 docs/cw-template-instantiatemsg.md create mode 100644 docs/cw-template-querymsg-oneof-getcount-properties-get_count.md create mode 100644 docs/cw-template-querymsg-oneof-getcount.md create mode 100644 docs/cw-template-querymsg.md create mode 100644 docs/cw-template-responses-getcountresponse-properties-count.md create mode 100644 docs/cw-template-responses-getcountresponse.md create mode 100644 docs/cw-template-responses.md create mode 100644 docs/cw-template.md create mode 100644 docs/schema/cw-template.json diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..b32b3594 --- /dev/null +++ b/docs/README.md @@ -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#` diff --git a/docs/cw-template-executemsg-oneof-0-properties-increment.md b/docs/cw-template-executemsg-oneof-0-properties-increment.md new file mode 100644 index 00000000..e3b22a53 --- /dev/null +++ b/docs/cw-template-executemsg-oneof-0-properties-increment.md @@ -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)) diff --git a/docs/cw-template-executemsg-oneof-0.md b/docs/cw-template-executemsg-oneof-0.md new file mode 100644 index 00000000..ea1f5f03 --- /dev/null +++ b/docs/cw-template-executemsg-oneof-0.md @@ -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)) diff --git a/docs/cw-template-executemsg-oneof-1-properties-reset-properties-count.md b/docs/cw-template-executemsg-oneof-1-properties-reset-properties-count.md new file mode 100644 index 00000000..3501d616 --- /dev/null +++ b/docs/cw-template-executemsg-oneof-1-properties-reset-properties-count.md @@ -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` diff --git a/docs/cw-template-executemsg-oneof-1-properties-reset.md b/docs/cw-template-executemsg-oneof-1-properties-reset.md new file mode 100644 index 00000000..7a11d326 --- /dev/null +++ b/docs/cw-template-executemsg-oneof-1-properties-reset.md @@ -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` diff --git a/docs/cw-template-executemsg-oneof-1.md b/docs/cw-template-executemsg-oneof-1.md new file mode 100644 index 00000000..b539e961 --- /dev/null +++ b/docs/cw-template-executemsg-oneof-1.md @@ -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)) diff --git a/docs/cw-template-executemsg.md b/docs/cw-template-executemsg.md new file mode 100644 index 00000000..aa27bd50 --- /dev/null +++ b/docs/cw-template-executemsg.md @@ -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") diff --git a/docs/cw-template-instantiatemsg-properties-count.md b/docs/cw-template-instantiatemsg-properties-count.md new file mode 100644 index 00000000..fe75e7f6 --- /dev/null +++ b/docs/cw-template-instantiatemsg-properties-count.md @@ -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` diff --git a/docs/cw-template-instantiatemsg.md b/docs/cw-template-instantiatemsg.md new file mode 100644 index 00000000..b4cd8137 --- /dev/null +++ b/docs/cw-template-instantiatemsg.md @@ -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` diff --git a/docs/cw-template-querymsg-oneof-getcount-properties-get_count.md b/docs/cw-template-querymsg-oneof-getcount-properties-get_count.md new file mode 100644 index 00000000..f290d524 --- /dev/null +++ b/docs/cw-template-querymsg-oneof-getcount-properties-get_count.md @@ -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)) diff --git a/docs/cw-template-querymsg-oneof-getcount.md b/docs/cw-template-querymsg-oneof-getcount.md new file mode 100644 index 00000000..662a8c3f --- /dev/null +++ b/docs/cw-template-querymsg-oneof-getcount.md @@ -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)) diff --git a/docs/cw-template-querymsg.md b/docs/cw-template-querymsg.md new file mode 100644 index 00000000..aca4b8aa --- /dev/null +++ b/docs/cw-template-querymsg.md @@ -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") diff --git a/docs/cw-template-responses-getcountresponse-properties-count.md b/docs/cw-template-responses-getcountresponse-properties-count.md new file mode 100644 index 00000000..69a3a6ec --- /dev/null +++ b/docs/cw-template-responses-getcountresponse-properties-count.md @@ -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` diff --git a/docs/cw-template-responses-getcountresponse.md b/docs/cw-template-responses-getcountresponse.md new file mode 100644 index 00000000..8e52489c --- /dev/null +++ b/docs/cw-template-responses-getcountresponse.md @@ -0,0 +1,43 @@ +# GetCountResponse Schema + +```txt +undefined#/responses/get_count +``` + +We define a custom struct for each query response + +| 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") | + +## get\_count Type + +`object` ([GetCountResponse](cw-template-responses-getcountresponse.md)) + +# get\_count Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------------- | :-------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------- | +| [count](#count) | `integer` | Required | cannot be null | [cw-template](cw-template-responses-getcountresponse-properties-count.md "undefined#/responses/get_count/properties/count") | + +## count + + + +`count` + +* is required + +* Type: `integer` + +* cannot be null + +* defined in: [cw-template](cw-template-responses-getcountresponse-properties-count.md "undefined#/responses/get_count/properties/count") + +### count Type + +`integer` + +### count Constraints + +**unknown format**: the value of this string must follow the format: `int32` diff --git a/docs/cw-template-responses.md b/docs/cw-template-responses.md new file mode 100644 index 00000000..a1686d1b --- /dev/null +++ b/docs/cw-template-responses.md @@ -0,0 +1,15 @@ +# Untitled undefined type in cw-template Schema + +```txt +undefined#/responses +``` + + + +| 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") | + +## responses Type + +unknown diff --git a/docs/cw-template.md b/docs/cw-template.md new file mode 100644 index 00000000..0f06eab8 --- /dev/null +++ b/docs/cw-template.md @@ -0,0 +1,19 @@ +# cw-template Schema + +```txt +undefined +``` + +# CW Template + +Base smart contract to start coding into the blockchain 🚀. + +This contract has been created with the cosmwasm [cw-template](https://github.com/InterWasm/cw-template) following the [cosmwasm documentation](https://docs.cosmwasm.com/fr/tutorials/simple-option/setup#project-starter). + +| 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") | + +## cw-template Type + +unknown ([cw-template](cw-template.md)) diff --git a/docs/schema/cw-template.json b/docs/schema/cw-template.json new file mode 100644 index 00000000..d45b7188 --- /dev/null +++ b/docs/schema/cw-template.json @@ -0,0 +1 @@ +{"contract_name":"cw-template","contract_version":"0.2.0","idl_version":"1.0.0","instantiate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"InstantiateMsg","description":"Instantiate CW-Template","type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int32"}},"additionalProperties":false},"execute":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ExecuteMsg","description":"Execute messages","oneOf":[{"type":"object","required":["increment"],"properties":{"increment":{"type":"object","additionalProperties":false}},"additionalProperties":false},{"type":"object","required":["reset"],"properties":{"reset":{"type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int32"}},"additionalProperties":false}},"additionalProperties":false}]},"query":{"$schema":"http://json-schema.org/draft-07/schema#","title":"QueryMsg","description":"Query messages","oneOf":[{"title":"GetCount","description":"GetCount returns the current count as a json-encoded number","type":"object","required":["get_count"],"properties":{"get_count":{"type":"object","additionalProperties":false}},"additionalProperties":false}]},"migrate":null,"sudo":null,"responses":{"get_count":{"$schema":"http://json-schema.org/draft-07/schema#","title":"GetCountResponse","description":"We define a custom struct for each query response","type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int32"}},"additionalProperties":false}},"description":"# CW Template\n\nBase smart contract to start coding into the blockchain 🚀.\n\nThis contract has been created with the cosmwasm [cw-template](https://github.com/InterWasm/cw-template) following the [cosmwasm documentation](https://docs.cosmwasm.com/fr/tutorials/simple-option/setup#project-starter).","title":"cw-template"}