diff --git a/packages/bruno-schema/readme.md b/packages/bruno-schema/readme.md index f9ca363e..edcb2e2a 100644 --- a/packages/bruno-schema/readme.md +++ b/packages/bruno-schema/readme.md @@ -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 +```