Skip to content

wip: filter documentation #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
toumorokoshi wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

wip: filter documentation #324

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions aep/general/0160/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,21 @@ extensions. An API **must** document any specific functions it supports,
including any limitations on their usage (for example, if a given function can
only be used on certain fields and/or with certain API methods).

### Annotation

```
x-aep-filter:
fields: # this field describes the fields that can be operated upon
- path
- description
# these are operations that are supported by the API. They match the
# name of the elements in the grammar.
# https://github.com/google/cel-spec/blob/master/doc/langdef.md#name-resolution
operations:
- 'ConditionalOr'
- 'ConditionalANd'
```

### Limitations

An API **may** support only a subset of the CEL language, and/or to support
Expand Down