docs: add new docs

axone-protocol · Oct 19, 2022 · 5b10317 · 5b10317
1 parent dfcf049
commit 5b10317
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -12,11 +12,11 @@
 
 *   [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`
+*   [Increment](./cw-template-executemsg-oneof-increment.md "Execute an increment message") – `undefined#/execute/oneOf/0`
 
-*   [Untitled object in cw-template](./cw-template-executemsg-oneof-0.md) – `undefined#/execute/oneOf/0`
+*   [InstantiateMsg](./cw-template-instantiatemsg.md "Instantiate messages") – `undefined#/instantiate`
 
-*   [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-increment-properties-increment.md) – `undefined#/execute/oneOf/0/properties/increment`
 
 *   [Untitled object in cw-template](./cw-template-executemsg-oneof-1.md) – `undefined#/execute/oneOf/1`
 

diff --git a/...xecutemsg-oneof-0-properties-increment.md → ...g-oneof-increment-properties-increment.md b/...xecutemsg-oneof-0-properties-increment.md → ...g-oneof-increment-properties-increment.md
@@ -12,4 +12,4 @@ undefined#/execute/oneOf/0/properties/increment
 
 ## increment Type
 
-`object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))
+`object` ([Details](cw-template-executemsg-oneof-increment-properties-increment.md))
diff --git a/docs/cw-template-executemsg-oneof-0.md → ...cw-template-executemsg-oneof-increment.md b/docs/cw-template-executemsg-oneof-0.md → ...cw-template-executemsg-oneof-increment.md
@@ -1,24 +1,24 @@
-# Untitled object in cw-template Schema
+# Increment Schema
 
 ```txt
 undefined#/execute/oneOf/0
 ```
 
-
+Execute an increment message.
 
 | 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))
+`object` ([Increment](cw-template-executemsg-oneof-increment.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") |
+| Property                | Type     | Required | Nullable       | Defined by                                                                                                                      |
+| :---------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------ |
+| [increment](#increment) | `object` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-increment-properties-increment.md "undefined#/execute/oneOf/0/properties/increment") |
 
 ## increment
 
@@ -28,12 +28,12 @@ undefined#/execute/oneOf/0
 
 *   is required
 
-*   Type: `object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))
+*   Type: `object` ([Details](cw-template-executemsg-oneof-increment-properties-increment.md))
 
 *   cannot be null
 
-*   defined in: [cw-template](cw-template-executemsg-oneof-0-properties-increment.md "undefined#/execute/oneOf/0/properties/increment")
+*   defined in: [cw-template](cw-template-executemsg-oneof-increment-properties-increment.md "undefined#/execute/oneOf/0/properties/increment")
 
 ### increment Type
 
-`object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))
+`object` ([Details](cw-template-executemsg-oneof-increment-properties-increment.md))
diff --git a/docs/cw-template-executemsg.md b/docs/cw-template-executemsg.md
@@ -16,6 +16,6 @@ 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")
+*   [Increment](cw-template-executemsg-oneof-increment.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.md b/docs/cw-template-instantiatemsg.md
@@ -4,7 +4,7 @@
 undefined#/instantiate
 ```
 
-Instantiate CW-Template
+Instantiate messages
 
 | Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                           |
 | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |

diff --git a/docs/schema/cw-template.json b/docs/schema/cw-template.json
@@ -1 +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"}
+{"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 messages","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":[{"title":"Increment","description":"Execute an increment message.","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"}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,4 +12,4 @@ undefined#/execute/oneOf/0/properties/increment

		## increment Type

		`object` ([Details](cw-template-executemsg-oneof-0-properties-increment.md))
		`object` ([Details](cw-template-executemsg-oneof-increment-properties-increment.md))
Original file line number	Diff line number	Diff line change
		@@ -1 +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"}
		{"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 messages","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":[{"title":"Increment","description":"Execute an increment message.","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"}