Skip to content

Commit 6d05b03

Browse files
committed
Add testcase section to variable
1 parent c50e466 commit 6d05b03

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/05-References/051-http-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ request:
165165

166166
### `request.auth[basic]`
167167

168-
`request.auth[basic]` is a sub-block, that is used to send basic authentication informaions with the request. It's to be used for [basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme). It only supports key value data, where both key and value should be scaler values. only `username` and `password` is supported. Adding any other value to it is expected to be fruitless.
168+
`request.auth[basic]` is a sub-block, that is used to send basic authentication informations with the request. It's to be used for [basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme). It only supports key value data, where both key and value should be scaler values. only `username` and `password` is supported. Adding any other value to it is expected to be fruitless.
169169

170170
> If a document already have `request.auth[bearer]` defined along with this block, `chk` will behave unexpectedly.
171171

docs/05-References/052-version-reference.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ title: Version specification reference
99

1010
### Introduction
1111

12+
**`important`** This node have to be available on each document.
1213

1314
The Version specification format is how someone write a document version. Usually we encourage user to write document version on the very top of a specification document, so that you don't miss it. However it can be written as a top-level key on any place of the document. This is how it looks like:
1415

@@ -23,10 +24,10 @@ Document version specifies which version of document current specification conte
2324
$ chk
2425
Usage: ...
2526

26-
v0.2.0 | version strings: 0.7.2
27+
v0.4.0 | version strings: 0.7.2
2728
...
2829
```
29-
- V0.2.0 is the tool version here
30+
- V0.4.0 is the tool version here
3031
- 0.7.2 is the document version it supports
3132

3233
If you have a document that have `version: default:http:0.8.0`, then this command would not be able to run it.
@@ -39,8 +40,6 @@ This version string have 3 parts: `<plugin>:<module>:<number>`, e.g: `default:ht
3940
- module: A plugin can install multiple module on registration. So, `http` is the module name in `chk http ..`. Usually these are registered as sub-commands to `chk`.
4041
- number: the document version in [SEMVER](https://semver.org/) format.
4142

42-
**`important`** This node have to be available on each document.
43-
4443
### Support document versions:
4544
- 0.7.2
4645

docs/05-References/053-variable-reference.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Variables are ways to hold value or computed values, like in programming languag
1515

1616
Variables can be defined in two ways:
1717

18-
1. Variable specification file. Files with `version: default:variable:x.x.x` [**WIP**]
18+
1. Variable specification file. Files with `version: default:variable:x.x.x` [**WIP** - not available yet]
1919
2. `variables` section on a supported specification document. See below.
2020
```yaml
2121
version: default:http:0.7.2
@@ -28,4 +28,5 @@ Variables can be defined in two ways:
2828

2929
### Supported specification document
3030

31-
- [Http specification document examples](/Examples/http-examples#variable-examples) | [More example](https://github.com/chkware/cli/tree/0272b83c2975349fd3f0d94e1646cc27b603eaf5/tests/resources/storage/sample_config/pass_cases/variables)
31+
- [Http specification document examples](/Examples/http-examples#variable-examples) | [More example](https://github.com/chkware/cli/tree/0272b83c2975349fd3f0d94e1646cc27b603eaf5/tests/resources/storage/sample_config/pass_cases/variables)
32+
- [Testcase specification document examples](/Examples/testcase-examples) | [More example](https://github.com/chkware/cli/tree/890c2a6c11c5b16be4678ac27083befa1ef0986c/tests/resources/storage/sample_config/pass_cases/UserCreate)

0 commit comments

Comments
 (0)