Type object
File match **/*.request
Schema URL https://catalog.lintel.tools/schemas/schemastore/rc3-request/latest.json
Source https://www.schemastore.org/rc3-request-0.0.3.json

Validate with Lintel

npx @lintel/lintel check
Type: object

RC request information

Properties

$schema string

The JSON schema to use for validation

comment string

A comment to provide documentation for this request

method string

The HTTP method to use for this request

Values: "GET" "POST" "PUT" "PATCH" "DELETE" "HEAD" "OPTIONS"
url string

The URL to use for this request

params Record<string, string>
1 nested properties
name string
form_data Record<string, string>
1 nested properties
name string
headers Record<string, string>
1 nested properties
name string
body object

The body of the request

2 nested properties
text string
json object
save_responses boolean

Whether to save .response files in the same dir as the .request file

extract object

JSON node, or Text pattern (with regex group) to extract from response

4 nested properties
json_path string

A JSON Path expression to extract a single field from JSON

text_pattern string

A Python regex pattern with a single REGEX GROUP to be extracted from the response

env string

Choose to store the extracted field in either the global env (default), or currently selected env from your collection

Values: "global" "current"
var string

The var name (default is token) in the environment to store the extracted value in

Definitions

nvp Record<string, string>
name string