docs: updated wording in openapi.yaml, added comments to tests in rpc.rs

This commit is contained in:
Pavitthra Pandurangan
2021-08-05 12:59:51 -04:00
parent 46fbbbd77d
commit 11d741b326
2 changed files with 104 additions and 15 deletions

View File

@@ -79,7 +79,7 @@ paths:
schema:
type: boolean
description: |
If use_latest_tip == true, the query will be run from the latest tip (includes unconfirmed state).
If use_latest_tip == true, the query will be run from the latest known tip (includes unconfirmed state).
If use_latest_tip == false or is unspecified, the tip is selected as usual (first checking value of the
tip parameter, otherwise taking the stacks chain tip).
/v2/map_entry/{contract_address}/{contract_name}/{map_name}:
@@ -139,7 +139,7 @@ paths:
schema:
type: boolean
description: |
If use_latest_tip == true, the query will be run from the latest tip (includes unconfirmed state).
If use_latest_tip == true, the query will be run from the latest known tip (includes unconfirmed state).
If use_latest_tip == false or is unspecified, the tip is selected as usual (first checking value of the
tip parameter, otherwise taking the stacks chain tip).
x-codegen-request-body-name: key
@@ -196,7 +196,7 @@ paths:
schema:
type: boolean
description: |
If use_latest_tip == true, the query will be run from the latest tip (includes unconfirmed state).
If use_latest_tip == true, the query will be run from the latest known tip (includes unconfirmed state).
If use_latest_tip == false or is unspecified, the tip is selected as usual (first checking value of the
tip parameter, otherwise taking the stacks chain tip).
@@ -252,7 +252,7 @@ paths:
schema:
type: boolean
description: |
If use_latest_tip == true, the query will be run from the latest tip (includes unconfirmed state).
If use_latest_tip == true, the query will be run from the latest known tip (includes unconfirmed state).
If use_latest_tip == false or is unspecified, the tip is selected as usual (first checking value of the
tip parameter, otherwise taking the stacks chain tip).
requestBody:
@@ -302,7 +302,7 @@ paths:
schema:
type: boolean
description: |
If use_latest_tip == true, the query will be run from the latest tip (includes unconfirmed state).
If use_latest_tip == true, the query will be run from the latest known tip (includes unconfirmed state).
If use_latest_tip == false or is unspecified, the tip is selected as usual (first checking value of the
tip parameter, otherwise taking the stacks chain tip).
responses:
@@ -376,7 +376,7 @@ paths:
schema:
type: boolean
description: |
If use_latest_tip == true, the query will be run from the latest tip (includes unconfirmed state).
If use_latest_tip == true, the query will be run from the latest known tip (includes unconfirmed state).
If use_latest_tip == false or is unspecified, the tip is selected as usual (first checking value of the
tip parameter, otherwise taking the stacks chain tip).
@@ -437,6 +437,6 @@ paths:
schema:
type: boolean
description: |
If use_latest_tip == true, the query will be run from the latest tip (includes unconfirmed state).
If use_latest_tip == true, the query will be run from the latest known tip (includes unconfirmed state).
If use_latest_tip == false or is unspecified, the tip is selected as usual (first checking value of the
tip parameter, otherwise taking the stacks chain tip).