From 5f26290f926e7e617d7d10f7d90329334ce141fb Mon Sep 17 00:00:00 2001 From: Alan Bernstein Date: Wed, 5 Aug 2020 12:26:22 -0500 Subject: [PATCH] Fix various docs issues --- docs/api-reference.md | 12 ++++++------ docs/glossary.md | 2 +- docs/query-language.md | 10 +++++----- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/api-reference.md b/docs/api-reference.md index c414d9bb5..b8f641cea 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -15,7 +15,7 @@ Is equivalent to `GET /schema` and returns the same response. ### List index schema -`GET /index/` +`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/` +`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//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//field//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//field/` +`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//field/` +`DELETE /index/{index-name}/field/{field-name}` Removes the given field. diff --git a/docs/glossary.md b/docs/glossary.md index 5d2533b02..a888fc7f2 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -58,7 +58,7 @@ nav = [] [Row (BSI)](../query-language/#row-bsi): A [PQL](#pql) query that returns bits based on comparison to integers stored in [BSI](#bsi) [fields](#field). -[Rows](../query-language/#rows): 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. +[Rows](../query-language/#rows): 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. [Slice](../data-model/#shard): Prior to Pilosa 1.0, shards were known as slices. diff --git a/docs/query-language.md b/docs/query-language.md index 310a4116c..012a04d9d 100644 --- a/docs/query-language.md +++ b/docs/query-language.md @@ -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 ...]) **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 \ No newline at end of file +* columns are repositories that were starred by any user