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