bruno/packages/bruno-schema/readme.md

32 lines
1.0 KiB
Markdown
Raw Permalink Normal View History

2022-10-11 00:09:26 +02:00
# bruno-schema
The schema definition for collections
### Publish to Npm Registry
```bash
npm publish --access=public
```
2022-10-11 00:09:26 +02:00
### Collection schema
2022-10-11 00:20:48 +02:00
```bash
id Unique id (when persisted to a db)
uid Unique id
name collection name
items Items (folders and requests)
|-uid A unique id
|-name Item name
|-type Item type (folder, http-request, graphql-request)
2022-10-11 00:20:48 +02:00
|-request Request object
|-url Request url
|-method Request method
|-headers Request headers (array of key-val)
|-params Request params (array of key-val)
|-body Request body object
|-mode Request body mode
|-json Request json body
|-text Request text body
|-xml Request xml body
|-multipartForm Request multipartForm body
|-formUrlEncoded Request formUrlEncoded body
```