Skip to content

Commit

Permalink
run yarn build
Browse files Browse the repository at this point in the history
  • Loading branch information
Natay committed Jan 29, 2025
1 parent 7260e55 commit 09e53fd
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions packages/schema/docs/build/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,13 +185,13 @@ Key | Required | Type | Description
#### Examples

* `{ key: 'email', type: 'string', isSafe: true, required: true }`
* `{ key: 'password', type: 'string', isSafe: false, required: true }`
* `{ key: 'password', type: 'password', isSafe: false, required: true }`
* `{ key: 'api_key', type: 'string', isSafe: false, required: true }`

#### Anti-Examples

* `{ key: 'password', type: 'string', isSafe: true, required: true }` - _A "password" field cannot have isSafe = true._
* `{ key: 'api_key', isSafe: true }` - _Missing "type". Also "api_key" is a sensitive field and cannot have isSafe=true._
* `{ key: 'password', type: 'password', isSafe: true, required: true }` - _A "password" field cannot have isSafe = true._
* `{ key: 'api_key', isSafe: true }` - _"api_key" is a sensitive field and cannot have isSafe set as true._
* `{ type: 'string', isSafe: false }` - _Missing required key: key_

-----
Expand All @@ -211,25 +211,25 @@ An array or collection of authentication fields.
* ```
[
{ key: 'username', type: 'string', isSafe: true, required: true },
{ key: 'password', type: 'string', isSafe: false, required: true }
{ key: 'password', type: 'password', isSafe: false, required: true }
]
```
* `[ { key: 'api_key', type: 'string', isSafe: false, required: true } ]`
* ```
[
{ key: 'email', type: 'string', isSafe: true },
{ key: 'password', type: 'string', required: true },
{ key: 'password', type: 'password', required: true },
{ key: 'mfa_token', type: 'string', isSafe: false }
]
```

#### Anti-Examples

* `{}` - _Must be an array (currently an object)._
* `[ { key: 'password', isSafe: true } ]` - _A password field cannot be marked as isSafe: true (violates AuthFieldSchema)._
* `[ { key: 'api_key', isSafe: true } ]` - _api_key is considered sensitive and cannot have isSafe = true._
* `[ { key: 'password', isSafe: true } ]` - _"password" is a sensitive field and cannot have isSafe set as true._
* `[ { key: 'api_key', isSafe: true } ]` - _"api_key" is a sensitive field and cannot have isSafe set as true._
* `[ { isSafe: false } ]` - _Missing required "key" property._
* `[ { key: 'username', type: 'string', isSafe: true }, 12345 ]` - _An array item is not an object (must match AuthFieldSchema)._
* `[ { key: 'username', type: 'string', isSafe: true }, 12345 ]` - _Array item 12345 is not an object (must match AuthFieldSchema)._

-----

Expand Down

0 comments on commit 09e53fd

Please sign in to comment.