Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/reference/metadata-reference/engine-plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,10 @@ Configuration for a lifecycle plugin hook request.

| Key | Value | Required | Description |
|-----|-----|-----|-----|
| `headers` | [HttpHeaders](#lifecyclepluginhook-httpheaders) / null | false | Configuration for the headers. |
| `headers` | [HttpHeaders](#lifecyclepluginhook-httpheaders) / null | false | Configuration for additional static header values to send to the plugin |
| `session` | [LeafConfig](#lifecyclepluginhook-leafconfig) / null | false | Configuration for the session (includes roles and session variables). |
| `ndcRequest` | [LeafConfig](#lifecyclepluginhook-leafconfig) / null | false | Configuration for the request. |
| `forwardHeaders` | [string] / null | false | Headers to be forwarded from the incoming request. |



Expand Down
165 changes: 163 additions & 2 deletions docs/reference/metadata-reference/permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ Definition of permissions for an OpenDD type.
| [TypePermissions (v1)](#typepermissions-typepermissions-(v1)) | |
| [TypePermissions (v2)](#typepermissions-typepermissions-(v2)) | |

**Example:**
**Examples:**

```yaml
kind: TypePermissions
Expand All @@ -245,6 +245,67 @@ definition:
```



```yaml
kind: TypePermissions
version: v2
definition:
typeName: article
roleBased:
permissions:
- role: admin
output:
allowedFields:
- article_id
- author_id
- title
- role: user
output:
allowedFields:
- article_id
- author_id
```



```yaml
kind: TypePermissions
version: v2
definition:
typeName: movie
permissions:
rulesBased:
- allowFields:
condition:
contains:
left:
sessionVariable: x-hasura-role
right:
literal:
- admin
- user
- user_not
- user_and
- user_or
- limited_fields_user
fields:
- movie_id
- rating
- title
- release_date
- denyFields:
condition:
contains:
left:
sessionVariable: x-hasura-role
right:
literal:
- limited_fields_user
fields:
- rating
```


#### TypePermissions (v2) {#typepermissions-typepermissions-(v2)}

| Key | Value | Required | Description |
Expand Down Expand Up @@ -436,6 +497,72 @@ definition:
```



```yaml
kind: ModelPermissions
version: v2
definition:
modelName: actors_by_movie
permissions:
rulesBased:
- allow:
condition:
contains:
left:
sessionVariable: x-hasura-role
right:
literal:
- admin
- user_with_preset_movie_id
- presetArgument:
condition:
equal:
left:
sessionVariable: x-hasura-role
right:
literal: user_with_preset_movie_id
argumentName: movie_id
value:
literal: 1
```



```yaml
kind: ModelPermissions
version: v2
definition:
modelName: actors
permissions:
rulesBased:
- allow:
condition:
contains:
left:
sessionVariable: x-hasura-role
right:
literal:
- admin
- object_relationship_user
- filter:
condition:
equal:
left:
sessionVariable: x-hasura-role
right:
literal: object_relationship_user
predicate:
relationship:
name: Country
predicate:
fieldComparison:
field: name
operator: _eq
value:
literal: UK
```


#### ModelPermissions (v2) {#modelpermissions-modelpermissions-(v2)}

| Key | Value | Required | Description |
Expand Down Expand Up @@ -905,7 +1032,7 @@ Definition of permissions for an OpenDD command.
| [CommandPermissions (v1)](#commandpermissions-commandpermissions-(v1)) | |
| [CommandPermissions (v2)](#commandpermissions-commandpermissions-(v2)) | |

**Example:**
**Examples:**

```yaml
kind: CommandPermissions
Expand All @@ -920,6 +1047,40 @@ definition:
```



```yaml
kind: CommandPermissions
version: v2
definition:
commandName: get_actors_with_filter
permissions:
rulesBased:
- allow:
condition:
contains:
left:
sessionVariable: x-hasura-role
right:
literal:
- filter_user
- presetArgument:
condition:
equal:
left:
sessionVariable: x-hasura-role
right:
literal: filter_user
argumentName: actor_bool_exp
value:
booleanExpression:
fieldComparison:
field: actor_id
operator: _eq
value:
literal: 4
```


#### CommandPermissions (v2) {#commandpermissions-commandpermissions-(v2)}

| Key | Value | Required | Description |
Expand Down
Loading
Loading