From 0cb88f8e01ffcd41d526754ba4407a84e872bea5 Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 08:58:23 +0200 Subject: [PATCH 01/10] openapi --- .../terminusx-db/reference-guides/http-api.md | 72 +++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index ece03086..83a2601d 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -2,6 +2,78 @@ API definitions for terminusdb. +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/ok" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/info" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/db/{organization}/{database}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/db/{organization}/{database}" method="delete" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/document/{path}" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/document/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/document/{path}" method="put" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/document/{path}" method="delete" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/woql" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/woql/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/branch/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/branch/{path}" method="delete" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/squash/{path}" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/reset/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/optimize/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/prefixes/{path}" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/diff" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/patch" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% endswagger %} + ### General rule The TerminusDB Server HTTP API JSON documents have optional elements notated with angle-brackets, for instance: From 9c97e26a295bf58df3d0db5d6885ae50725f4f83 Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 09:00:47 +0200 Subject: [PATCH 02/10] Use various branch --- .../terminusx-db/reference-guides/http-api.md | 72 +++++++++---------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index 83a2601d..f29842ea 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -2,76 +2,76 @@ API definitions for terminusdb. -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/ok" method="get" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/ok" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/info" method="get" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/info" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/db/{organization}/{database}" method="post" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/db/{organization}/{database}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/db/{organization}/{database}" method="delete" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/db/{organization}/{database}" method="delete" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/document/{path}" method="get" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{path}" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/document/{path}" method="post" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/document/{path}" method="put" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{path}" method="put" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/document/{path}" method="delete" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{path}" method="delete" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/woql" method="post" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/woql" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/woql/{path}" method="post" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/woql/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/branch/{path}" method="post" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/branch/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/branch/{path}" method="delete" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/branch/{path}" method="delete" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/squash/{path}" method="get" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/squash/{path}" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/reset/{path}" method="post" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/reset/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/optimize/{path}" method="post" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/optimize/{path}" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/prefixes/{path}" method="get" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/prefixes/{path}" method="get" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/diff" method="post" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/diff" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml" path="/patch" method="post" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/main/terminusdb.yaml) +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/patch" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} ### General rule From 348d672e8cb682c9b0fea766308c5a3263de26ea Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 10:23:30 +0200 Subject: [PATCH 03/10] Add section headers --- .../terminusx-db/reference-guides/http-api.md | 52 ++++++++++++++++--- 1 file changed, 44 insertions(+), 8 deletions(-) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index f29842ea..9d079c5a 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -2,11 +2,11 @@ API definitions for terminusdb. -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/ok" method="get" %} -[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) -{% endswagger %} +## Databases -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/info" method="get" %} +These endpoints support the management of databases. + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/" method="get" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} @@ -18,6 +18,10 @@ API definitions for terminusdb. [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} +## Documents + +These endpoints support the Document Interface. + {% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{path}" method="get" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} @@ -34,6 +38,22 @@ API definitions for terminusdb. [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} +## JSON Diff & Patch + +These endpoints support diff and patch operations on JSON. + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/diff" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) +{% endswagger %} + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/patch" method="post" %} +[https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) +{% endswagger %} + +## WOQL + +These endpoints support the Web Object Query Language (WOQL). + {% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/woql" method="post" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} @@ -42,6 +62,10 @@ API definitions for terminusdb. [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} +## Branch + +These endpoints provide branch operations on a database. + {% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/branch/{path}" method="post" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} @@ -58,19 +82,31 @@ API definitions for terminusdb. [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/optimize/{path}" method="post" %} +## Prefixes + +These endpoints provide access to prefixes. + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/prefixes/{path}" method="get" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/prefixes/{path}" method="get" %} +## Optimize + +These endpoints provide operations to optimize a database. + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/optimize/{path}" method="post" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/diff" method="post" %} +## Server + +These endpoints provide information about the server. + +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/info" method="get" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/patch" method="post" %} +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/ok" method="get" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} From 6643cc1b1ebf27ac0bcc2425e1927a472e757ad1 Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 14:03:02 +0200 Subject: [PATCH 04/10] Initial curl tabs --- .../terminusx-db/reference-guides/http-api.md | 78 ++++++++++++++++++- 1 file changed, 77 insertions(+), 1 deletion(-) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index 9d079c5a..22dec4cd 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -1,6 +1,64 @@ +--- +description: TerminusDB HTTP API documentation. +--- + # HTTP API Reference -API definitions for terminusdb. +## Introduction + +This page contains documentation on how to use +[TerminusDB](https://terminusdb.com/) through HTTP API operations. + +This page includes examples using [`curl`][curl]. To get started with these, +first set up some environment variables. These will depend on which host you are +using. + +[curl]: https://curl.se/ + +{% tabs %} + +{% tab title="Local" %} +First, set your user. For a new installation, use `admin`. + +```shell +export TERMINUSDB_USER="my_user" +``` + +Then, set the password for this user. For a new installation, use `root`. +```shell +export TERMINUSDB_PASS="my_pass" +``` +{% endtab %} + +{% tab title="TerminusX" %} +For TerminusX, you need an access token (API key). [Get your API +key][get_api_key] if you don't already have one. +```shell +export TERMINUSDB_ACCESS_TOKEN="replace_this_with_your_api_key" +``` +{% endtab %} + +{% endtabs %} + +[get_api_key]: readme/terminusx/quick-start/get-api-key.md + +{% tabs %} + +{% tab title="Local" %} +```shell +curl "http://localhost:6363/api/" \ + -u $TERMINUSDB_USER:$TERMINUSDB_PASS +``` +{% endtab %} + +{% tab title="TerminusX" %} +```shell +curl "https://cloud.terminusdb.com/my_team/api/" \ + -H "API_TOKEN: $TERMINUSDB_ACCESS_TOKEN" +``` +{% endtab %} + +{% endtabs %} ## Databases @@ -10,6 +68,24 @@ These endpoints support the management of databases. [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} +{% tabs %} + +{% tab title="Local" %} +```shell +curl 'http://localhost:6363/api/' \ +-u $TERMINUSDB_USER:$TERMINUSDB_PASS +``` +{% endtab %} + +{% tab title="TerminusX" %} +```shell +curl https://cloud.terminusdb.com/my_team/api/ \ + -H "API_TOKEN: $TERMINUSDB_ACCESS_TOKEN" +``` +{% endtab %} + +{% endtabs %} + {% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/db/{organization}/{database}" method="post" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} From aebf13951b0d25261b2dfbd4cb18a09cac4d4857 Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 14:07:19 +0200 Subject: [PATCH 05/10] Remove duplicate, add admin/root --- .../terminusx-db/reference-guides/http-api.md | 28 ++++--------------- 1 file changed, 5 insertions(+), 23 deletions(-) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index 22dec4cd..65af3749 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -18,15 +18,15 @@ using. {% tabs %} {% tab title="Local" %} -First, set your user. For a new installation, use `admin`. +First, set the user. For a new installation, use `admin`. ```shell -export TERMINUSDB_USER="my_user" +export TERMINUSDB_USER="admin" ``` -Then, set the password for this user. For a new installation, use `root`. +Then, set the password. For a new installation, use `root`. ```shell -export TERMINUSDB_PASS="my_pass" +export TERMINUSDB_PASS="root" ``` {% endtab %} @@ -42,24 +42,6 @@ export TERMINUSDB_ACCESS_TOKEN="replace_this_with_your_api_key" [get_api_key]: readme/terminusx/quick-start/get-api-key.md -{% tabs %} - -{% tab title="Local" %} -```shell -curl "http://localhost:6363/api/" \ - -u $TERMINUSDB_USER:$TERMINUSDB_PASS -``` -{% endtab %} - -{% tab title="TerminusX" %} -```shell -curl "https://cloud.terminusdb.com/my_team/api/" \ - -H "API_TOKEN: $TERMINUSDB_ACCESS_TOKEN" -``` -{% endtab %} - -{% endtabs %} - ## Databases These endpoints support the management of databases. @@ -73,7 +55,7 @@ These endpoints support the management of databases. {% tab title="Local" %} ```shell curl 'http://localhost:6363/api/' \ --u $TERMINUSDB_USER:$TERMINUSDB_PASS + -u $TERMINUSDB_USER:$TERMINUSDB_PASS ``` {% endtab %} From 9eb7d8a18dc057b049c52119a06fe58070ea1e90 Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 14:17:03 +0200 Subject: [PATCH 06/10] TERMINUSDB_ORG --- .../terminusx-db/reference-guides/http-api.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index 65af3749..b16b5293 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -25,17 +25,34 @@ export TERMINUSDB_USER="admin" ``` Then, set the password. For a new installation, use `root`. + ```shell export TERMINUSDB_PASS="root" ``` + +Finally, set the organization housing your databases. For a new installation, +use `admin`. + +```shell +export TERMINUSDB_ORG="admin" +``` {% endtab %} {% tab title="TerminusX" %} For TerminusX, you need an access token (API key). [Get your API key][get_api_key] if you don't already have one. + ```shell export TERMINUSDB_ACCESS_TOKEN="replace_this_with_your_api_key" ``` + +Finally, set the organization housing your databases. On initial sign-up to +TerminusX, you start with an organization (or team) with the same name as your +username. + +```shell +export TERMINUSDB_ORG="my_user" +``` {% endtab %} {% endtabs %} @@ -61,7 +78,7 @@ curl 'http://localhost:6363/api/' \ {% tab title="TerminusX" %} ```shell -curl https://cloud.terminusdb.com/my_team/api/ \ +curl "https://cloud.terminusdb.com/$TERMINUSDB_ORG/api/" \ -H "API_TOKEN: $TERMINUSDB_ACCESS_TOKEN" ``` {% endtab %} From 1005ff1949ac98ac07419cd83450458faa7684f4 Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 14:20:37 +0200 Subject: [PATCH 07/10] language --- readme/terminusx-db/reference-guides/http-api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index b16b5293..0d6e3cbf 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -39,8 +39,8 @@ export TERMINUSDB_ORG="admin" {% endtab %} {% tab title="TerminusX" %} -For TerminusX, you need an access token (API key). [Get your API -key][get_api_key] if you don't already have one. +First, you need an access token (API key). [Get an API key][get_api_key] if you +don't already have one. ```shell export TERMINUSDB_ACCESS_TOKEN="replace_this_with_your_api_key" From e3acfd9191c6790e6b3ffe918ea9d8d820205d46 Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 14:38:15 +0200 Subject: [PATCH 08/10] db post curl --- .../terminusx-db/reference-guides/http-api.md | 28 ++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index 0d6e3cbf..0e90b26a 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -71,7 +71,7 @@ These endpoints support the management of databases. {% tab title="Local" %} ```shell -curl 'http://localhost:6363/api/' \ +curl "http://localhost:6363/api/" \ -u $TERMINUSDB_USER:$TERMINUSDB_PASS ``` {% endtab %} @@ -89,6 +89,32 @@ curl "https://cloud.terminusdb.com/$TERMINUSDB_ORG/api/" \ [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} +{% tabs %} + +{% tab title="Local" %} +Create a database with the identifier `my_database`: + +```shell +curl "http://localhost:6363/api/db/$TERMINUSDB_ORG/my_database" \ + -u $TERMINUSDB_USER:$TERMINUSDB_PASS \ + -X POST \ + -H "Content-Type: application/json" \ + -d '{"label": "My Database", "comment": "The best database ever"}' +``` +{% endtab %} + +{% tab title="TerminusX" %} +```shell +curl "https://cloud.terminusdb.com/$TERMINUSDB_ORG/api/db/$TERMINUSDB_ORG/my_database" \ + -H "API_TOKEN: $TERMINUSDB_ACCESS_TOKEN" \ + -X POST \ + -H "Content-Type: application/json" \ + -d '{"label": "My Database", "comment": "The best database ever"}' +``` +{% endtab %} + +{% endtabs %} + {% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/db/{organization}/{database}" method="delete" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} From c71d8acd02adf2215516fdc4d8e49e3f1b87e37e Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 14:46:55 +0200 Subject: [PATCH 09/10] db delete curl --- .../terminusx-db/reference-guides/http-api.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index 0e90b26a..e1b57e77 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -104,6 +104,8 @@ curl "http://localhost:6363/api/db/$TERMINUSDB_ORG/my_database" \ {% endtab %} {% tab title="TerminusX" %} +Create a database with the identifier `my_database`: + ```shell curl "https://cloud.terminusdb.com/$TERMINUSDB_ORG/api/db/$TERMINUSDB_ORG/my_database" \ -H "API_TOKEN: $TERMINUSDB_ACCESS_TOKEN" \ @@ -119,6 +121,31 @@ curl "https://cloud.terminusdb.com/$TERMINUSDB_ORG/api/db/$TERMINUSDB_ORG/my_dat [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} +{% tabs %} + +{% tab title="Local" %} +Delete the database with the identifier `my_database`: + +```shell +curl "http://localhost:6363/api/db/$TERMINUSDB_ORG/my_database" \ + -u $TERMINUSDB_USER:$TERMINUSDB_PASS \ + -X DELETE +``` +{% endtab %} + +{% tab title="TerminusX" %} +Delete the database with the identifier `my_database`: + +```shell +curl "https://cloud.terminusdb.com/$TERMINUSDB_ORG/api/db/$TERMINUSDB_ORG/my_database" \ + -H "API_TOKEN: $TERMINUSDB_ACCESS_TOKEN" \ + -X DELETE +``` +{% endtab %} + +{% endtabs %} + + ## Documents These endpoints support the Document Interface. From 6eec73c4843e52bcec17147910084c925ef1d054 Mon Sep 17 00:00:00 2001 From: Sean Leather Date: Tue, 8 Feb 2022 14:59:09 +0200 Subject: [PATCH 10/10] path -> resource --- readme/terminusx-db/reference-guides/http-api.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/readme/terminusx-db/reference-guides/http-api.md b/readme/terminusx-db/reference-guides/http-api.md index e1b57e77..2cde19a6 100644 --- a/readme/terminusx-db/reference-guides/http-api.md +++ b/readme/terminusx-db/reference-guides/http-api.md @@ -145,24 +145,23 @@ curl "https://cloud.terminusdb.com/$TERMINUSDB_ORG/api/db/$TERMINUSDB_ORG/my_dat {% endtabs %} - ## Documents These endpoints support the Document Interface. -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{path}" method="get" %} +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{resource}" method="get" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{path}" method="post" %} +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{resource}" method="post" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{path}" method="put" %} +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{resource}" method="put" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %} -{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{path}" method="delete" %} +{% swagger src="https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml" path="/document/{resource}" method="delete" %} [https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml](https://raw.githubusercontent.com/terminusdb/openapi-specs/various/terminusdb.yaml) {% endswagger %}