mirror of
https://github.com/featurebasedb/featurebase.git
synced 2026-10-07 11:27:50 +00:00
Fix various docs issues
This commit is contained in:
parent
3fb2cccb00
commit
5f26290f92
3 changed files with 12 additions and 12 deletions
|
|
@ -15,7 +15,7 @@ Is equivalent to `GET /schema` and returns the same response.
|
|||
|
||||
### List index schema
|
||||
|
||||
`GET /index/<index-name>`
|
||||
`GET /index/{index-name}`
|
||||
|
||||
Returns the schema of the specified index in JSON.
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ curl -XGET localhost:10101/index/user
|
|||
|
||||
### Create index
|
||||
|
||||
`POST /index/<index-name>`
|
||||
`POST /index/{index-name}`
|
||||
|
||||
Creates an index with the given name.
|
||||
|
||||
|
|
@ -79,7 +79,7 @@ curl -XDELETE localhost:10101/index/user
|
|||
|
||||
### Query index
|
||||
|
||||
`POST /index/<index-name>/query`
|
||||
`POST /index/{index-name}/query`
|
||||
|
||||
Sends a [query](../query-language/) to the Pilosa server with the given index. The request body is UTF-8 encoded text and response body is in JSON by default.
|
||||
|
||||
|
|
@ -137,7 +137,7 @@ By default, all bits and attributes (*for `Row` queries only*) are returned. In
|
|||
|
||||
### Import Data
|
||||
|
||||
`POST /index/<index-name>/field/<field-name>/import`
|
||||
`POST /index/{index-name}/field/{field-name}/import`
|
||||
|
||||
Supports high-rate data ingest to a particular shard of a particular field. The
|
||||
official client libraries use this endpoint for their import functionality - it
|
||||
|
|
@ -185,7 +185,7 @@ message ImportRequest {
|
|||
|
||||
### Create field
|
||||
|
||||
`POST /index/<index-name>/field/<field-name>`
|
||||
`POST /index/{index-name}/field/{field-name}`
|
||||
|
||||
Creates a field in the given index with the given name.
|
||||
|
||||
|
|
@ -241,7 +241,7 @@ curl localhost:10101/index/repository/field/stats \
|
|||
|
||||
### Remove field
|
||||
|
||||
`DELETE /index/<index-name>/field/<field-name>`
|
||||
`DELETE /index/{index-name}/field/{field-name}`
|
||||
|
||||
Removes the given field.
|
||||
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ nav = []
|
|||
|
||||
<strong id="range-bsi">[Row (BSI)](../query-language/#row-bsi):</strong> A [PQL](#pql) query that returns bits based on comparison to integers stored in [BSI](#bsi) [fields](#field).
|
||||
|
||||
<strong id="rows">[Rows](../query-language/#rows):<strong> A [PQL](#pql) query that returns a list of row IDs in the given field which have at least one bit set. The field argument is mandatory, the others are optional. `Rows` is the primary argument used with the [GroupBy](#groupby) query.
|
||||
<strong id="rows">[Rows](../query-language/#rows):</strong> A [PQL](#pql) query that returns a list of row IDs in the given field which have at least one bit set. The field argument is mandatory, the others are optional. `Rows` is the primary argument used with the [GroupBy](#groupby) query.
|
||||
|
||||
<strong id="slice">[Slice](../data-model/#shard):</strong> Prior to Pilosa 1.0, shards were known as slices.
|
||||
|
||||
|
|
|
|||
|
|
@ -429,9 +429,9 @@ Union([ROW_CALL ...])
|
|||
|
||||
**Description:**
|
||||
|
||||
Union performs a logical OR on the results of all `ROW_CALL` queries passed to it.
|
||||
Union performs a set union on the column indexes in the results of all `ROW_CALL` queries passed to it. In comparison to a relational query, this is similar to combining clauses in the "OR" sense.
|
||||
|
||||
**Result Type:** object with attrs and bits
|
||||
**Result Type:** object with attrs and columns
|
||||
|
||||
attrs will always be empty
|
||||
|
||||
|
|
@ -457,7 +457,7 @@ Intersect(<ROW_CALL>, [ROW_CALL ...])
|
|||
|
||||
**Description:**
|
||||
|
||||
Intersect performs a logical AND on the results of all `ROW_CALL` queries passed to it.
|
||||
Intersect performs a set intersection on the column indexes in the results of all `ROW_CALL` queries passed to it. In comparison to a relational query, this is similar to combining clauses in the "AND" sense.
|
||||
|
||||
**Result Type:** object with attrs and columns
|
||||
|
||||
|
|
@ -949,7 +949,7 @@ UnionRows([ROWSET_CALL ...])
|
|||
|
||||
UnionRows performs a logical OR on the rows matched by the results of all `ROWSET_CALL` queries passed to it.
|
||||
|
||||
**Result Type:** object with attrs and bits
|
||||
**Result Type:** object with attrs and columns
|
||||
|
||||
attrs will always be empty
|
||||
|
||||
|
|
@ -963,4 +963,4 @@ UnionRows(Rows(stargazer))
|
|||
{"attrs":{},"columns":[10, 20, 30]}
|
||||
```
|
||||
|
||||
* columns are repositories that were starred by any user
|
||||
* columns are repositories that were starred by any user
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue