Skip to content
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

Spec update for sort clause, updateOne and deleteOne #401

Merged
merged 1 commit into from
Apr 26, 2023
Merged

Spec update for sort clause, updateOne and deleteOne #401

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
41 changes: 31 additions & 10 deletions docs/jsonapi-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,6 +598,15 @@ If an error occurs the command will still return `status` as some documents may

### deleteOne Command

*Syntax:*

```bnf
<delete-one-command> ::= delete-one <delete-one-command-payload>

<delete-one-command-payload> ::= <filter-clause>?
<sort-clause>?
```

#### deleteOne Command Options

The `deleteOne` command does not support any options.
Expand Down Expand Up @@ -1001,6 +1010,17 @@ If an error occurs the command will still return `status` as some documents may

### updateOne Command

```bnf
<update-one-command> ::= deleteOne <update-one-command-payload>

<update-one-command-payload> ::= <filter-clause>?
<update-clause>?
<sort-clause>?
<update-one-command-options>?

<update-one-command-options> ::= <update-one-command-options>?
```

#### updateOne Command Options

`<update-one-command-options>` is a map of key-value pairs that modify the behavior of the command. All options are optional, with default behavior applied when not provided.
Expand Down Expand Up @@ -1672,26 +1692,27 @@ of this include ordering a large result set that will returned as pages,
or sorting a candidate set of documents to determine which document will
be returned when only a single document is required.

**TODO** THis is wrong, it needs to be a map.

*Syntax:*

```
`<sort-clause>` ::= [`<sort-expression>` *]
`<sort-clause>` ::= `<sort-expression>` *
`<sort-expression>` ::= `<sort-field-path>` `<sort-field-order>`
`<sort-field-path>` ::= `<document-path>`
`<sort-field-order>` ::= `<sort-ascending>` | `<sort-descending>`
`<sort-ascending>` ::= `1`
`<sort-descending>` ::= `-1`

`<sort-expression>` ::= (-)?`<document-path>`
```

Each `<sort-clause>` contains an ordered list of `<sort-expression>`'s
which are used to sort a candidate set of documents. The order of
Each `<sort-clause>` contains a json document `<sort-expression>`'s
which are used to sort set of documents. The order of
`<sort-expression>`'s is important and should be preserved as the
request is transmitted and processed.

Each `<sort-expression>` identifies a field in the document to sort by.
By default the field values are sorted in ascending order, if the field
name is prefixed with a `-` the field is sorted in descending order. A
maximum of **TODO** number of `<sort-expression>`'s may be included in a
`<sort-clause>`.
`<sort-field-path>` is a [Document Path](#document-path) that identifies
the field to sort by.
`<sort-field-order>` can have value `1` for ascending and `-1` for descending order.

*Sample:*

Expand Down