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
4 changes: 2 additions & 2 deletions src/api/1/controller-auth/get-my-rights/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Each right is an object with the following properties:

* `controller`: API controller
* `action`: controller's action
* `index`: authorized or denied data index
* `collection`: authorized or denied data collection
* `index`: authorized or denied index
* `collection`: authorized or denied collection
* `value`: one of the following value: `denied`, `allowed`, or `conditional`

```javascript
Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-bulk/import/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

---

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-collection/create/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ Body:

## Arguments

* `collection`: data collection to create
* `index`: data index that will host the new data collection
* `collection`: collection name to create
* `index`: index name that will host the new collection

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ title: deleteSpecifications

{{{since "1.0.0"}}}

Deletes validation specifications for a data collection.
Deletes validation specifications for a collection.

The request succeeds even if no specification exist for that data collection.
The request succeeds even if no specification exist for that collection.

***Note:*** an empty specification is implicitly applied to all collections. In a way, "no specification set" means "all documents are valid".

Expand Down Expand Up @@ -39,8 +39,8 @@ Method: DELETE

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

---

Expand Down
6 changes: 3 additions & 3 deletions src/api/1/controller-collection/exists/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ Method: GET

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

---

## Response

Returns a boolean telling whether the provided data collection exists:
Returns a boolean telling whether the provided collection exists:

```js
{
Expand Down
6 changes: 3 additions & 3 deletions src/api/1/controller-collection/get-mapping/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: getMapping

{{{since "1.0.0"}}}

Returns a data collection mapping.
Returns a collection mapping.

---

Expand Down Expand Up @@ -36,8 +36,8 @@ Method: GET

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

---

Expand Down
8 changes: 4 additions & 4 deletions src/api/1/controller-collection/get-specifications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,17 @@ Method: GET

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

---

## Response

Returns a specifications object with the following properties:

* `collection`: specified data collection
* `index`: specified data index
* `collection`: specified collection
* `index`: specified index
* `validation`: specifications description

```js
Expand Down
10 changes: 5 additions & 5 deletions src/api/1/controller-collection/list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: list

{{{since "1.0.0"}}}

Returns the list of data collections associated to a provided data index.
Returns the list of collections associated to a provided index.

The returned list is sorted in alphanumerical order.

Expand Down Expand Up @@ -41,8 +41,8 @@ Method: GET
## Arguments


* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand All @@ -55,8 +55,8 @@ Method: GET

Returns an array of objects, each one of those describing a collection, using the following properties:

* `name`: data collection name
* `type`: data collection type (either `stored` or `realtime`)
* `name`: collection name
* `type`: collection type (either `stored` or `realtime`)

Example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ Method: GET

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name
* `scrollId`: cursor identifier, obtained with ({{ site_base_path }}api/1/controller-collection/search-specifications)

### Optional:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-collection/truncate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Method: DELETE

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

---

Expand Down
6 changes: 3 additions & 3 deletions src/api/1/controller-collection/update-mapping/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: updateMapping

{{{since "1.0.0"}}}

Updates a data collection mapping.
Updates a collection mapping.

---

Expand Down Expand Up @@ -68,8 +68,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ The provided body must have the following structure:

```json
{
"<data index>": {
"<data collection>": {
"<index>": {
"<collection>": {
"strict": <boolean>,
"fields": {
// field validation rules
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ The provided body must have the following structure:

```json
{
"<data index>": {
"<data collection>": {
"<index>": {
"<collection>": {
"strict": <boolean>,
"fields": {
// field validation rules
Expand Down
8 changes: 4 additions & 4 deletions src/api/1/controller-document/count/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ title: count

{{{since "1.0.0"}}}

Counts documents in a data collection.
Counts documents in a collection.

A query can be provided to alter the count result, otherwise returns the total number of documents in the data collection.
A query can be provided to alter the count result, otherwise returns the total number of documents in the collection.

---

Expand Down Expand Up @@ -52,8 +52,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/create-or-replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ Body:

## Arguments

* `collection`: data collection
* `collection`: collection name
* `documentId`: unique identifier of the document to create or replace
* `index`: data index
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/create/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/delete-by-query/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

---

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/delete/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Method: DELETE

## Arguments

* `collection`: data collection
* `collection`: collection name
* `documentId`: document unique identifier
* `index`: data index
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/get/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ Method: GET

## Arguments

* `collection`: data collection
* `collection`: collection name
* `documentId`: document unique identifier
* `index`: data index
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/m-create-or-replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/m-create/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/m-delete/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/m-get/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/m-replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/m-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ Body:

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ Body:

## Arguments

* `collection`: data collection
* `collection`: collection name
* `documentId`: unique ID of the document to replace
* `index`: data index
* `index`: index name

### Optional:

Expand Down
4 changes: 2 additions & 2 deletions src/api/1/controller-document/scroll/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Method: GET

## Arguments

* `collection`: data collection
* `index`: data index
* `collection`: collection name
* `index`: index name
* `scrollId`: cursor unique identifier, obtained by either a search or a scroll query

### Optional:
Expand Down
Loading