holm/bruno
1
0
Fork 0
forked from extern/bruno
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: updated bruno-schema readme

Browse Source
This commit is contained in:
Anoop M D 2022-10-11 03:50:48 +05:30
parent aed737ed33
commit 42984ce931
1 changed files with 22 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
packages/bruno-schema/readme.md
View File

@ -3,28 +3,27 @@
The schema definition for collections
### Todo
[ ] Schema validator
[] Schema validator
### Collection schema
| Key | Description |
| -----------------------| --------------------------------------- |
| id | Unique id (when persisted to a db) |
| uid | Unique id |
| name | The collection name |
| items | The items (folders and requests) |
| -- uid | A unique id |
| -- name | The request name |
| -- request | The request object |
| ---- type | The request type (http, graphql) |
| ---- url | The request url |
| ---- method | The request method |
| ---- headers | The request headers (array of key-val) |
| ---- params | The request params (array of key-val) |
| ---- body | The request body object |
| ------ mode | The request body mode ['none', 'json', 'text', 'xml', 'multipartForm', 'formUrlEncoded'] |
| ------ json | The json body |
| ------ text | The text body |
| ------ xml | The xml body |
| ------ multipartForm | The multipartForm body |
| ------ formUrlEncoded | The formUrlEncoded body |
```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 Request name
|-request Request object
|-type Request type (http, graphql)
|-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
```