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.

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

docs: fix typos in markdown file of dc-agents #9950

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions dc-agents/DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ If the agent only supports table columns that are always nullable, then it shoul

### Interpolated Queries

Interpolated queries are lists of strings and scalars that represent applied templates of analagous form to [`select * from users where id = `, 5].
Interpolated queries are lists of strings and scalars that represent applied templates of analogous form to [`select * from users where id = `, 5].

By declaring support for the `interpolated_queries` capability the Hasura admin understands that they will be able to define native queries that leverage this cabability through the agent.

Expand Down Expand Up @@ -515,7 +515,7 @@ and here is the resulting query request payload:
}
```

The implementation of the service is responsible for intepreting this data structure and producing a JSON response body which is compatible with both the query and the schema.
The implementation of the service is responsible for interpreting this data structure and producing a JSON response body which is compatible with both the query and the schema.

Let's break down the request:

Expand Down Expand Up @@ -735,7 +735,7 @@ Values (as used in `value` in `binary_op` and the `values` array in `binary_arr_

Columns (as used in `column` fields in `binary_op`, `binary_arr_op`, `unary_op` and in `column`-typed Values) are specified as a column `name`, a `column_type` to denote the scalar type of the column, as well as optionally a `path` to the table that contains the column. If the `path` property is missing/null or an empty array, then the column is on the current table. However, if the path is `["$"]`, then the column is on the table involved in the Query that the whole `where` expression is from. At this point in time, these are the only valid values of `path`.

Here is a simple example, which correponds to the predicate "`first_name` is John and `last_name` is Smith":
Here is a simple example, which corresponds to the predicate "`first_name` is John and `last_name` is Smith":

```json
{
Expand Down Expand Up @@ -3348,4 +3348,4 @@ flowchart TD;
CONFIG --> SCHEMA["POST /schema"];
CONFIG --> QUERY["POST /query"];
CONFIG --> MUTATION["POST /mutation"];
```
```
6 changes: 3 additions & 3 deletions dc-agents/sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ Note: If you are using a hybrid setup of native and docker services (especially
While the reference agent should provide a fleshed out example of how an agent can be developed and what capabilities are possible, the following principles should also provide guidance how we recommend an agent be developed and structured:

* Capabilities & Self Describing - Your agent should describe itself via the `capabilities` feature.
* Stateless - Your agent should be (transparently) stateless, each request carries all the infomation required
* Defer logic to backend - Your agent should endevour to offload processing to its backend if possible
* Stateless - Your agent should be (transparently) stateless, each request carries all the information required
* Defer logic to backend - Your agent should endeavour to offload processing to its backend if possible
* Type-safe - Your agent should expect and return types as described in the OpenAPI schema
* Backwards compatible - Your agent should preserve backwards compatibility as it evolves
* Testing - Your agent should be tested with the provided test-suite
Expand Down Expand Up @@ -105,4 +105,4 @@ To run the tests against the reference agent, run `docker compose run tests` (th

A copy of the reference agent is included in the folder `reference`. This is implemented in TypeScript and includes its own `README.md` file for configuring and running. While the reference agent is able to be run natively, for convenience, a docker container is available and the reference agent will be started when running `docker compose up`. If you wish to run the reference agent on its own you can run `docker compose run reference-agent`.

NOTE: You will need to expose the desired ports if you wish to connect to this agent from native system services.
NOTE: You will need to expose the desired ports if you wish to connect to this agent from native system services.
2 changes: 1 addition & 1 deletion dc-agents/sqlite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Note: Boolean flags `{FLAG}` can be provided as `1`, `true`, `t`, `yes`, `y`, or
| `DB_READONLY` | `{FLAG}` | `false` | Makes databases readonly. |
| `DB_ALLOW_LIST` | `DB1[,DB2]*` | Any Allowed | Restrict what databases can be connected to. |
| `DB_PRIVATECACHE` | `{FLAG}` | Shared | Keep caches between connections private. |
| `DEBUGGING_TAGS` | `{FLAG}` | `false` | Outputs xml style tags in query comments for deugging purposes. |
| `DEBUGGING_TAGS` | `{FLAG}` | `false` | Outputs xml style tags in query comments for debugging purposes. |
| `PRETTY_PRINT_LOGS` | `{FLAG}` | `false` | Uses `pino-pretty` to pretty print request logs |
| `LOG_LEVEL` | `fatal` \| `error` \| `info` \| `debug` \| `trace` \| `silent` | `info` | The minimum log level to output |
| `METRICS` | `{FLAG}` | `false` | Enables a `/metrics` prometheus metrics endpoint.
Expand Down
2 changes: 1 addition & 1 deletion dc-agents/sqlite/test/TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ docker compose up -d

![Screen Shot 2022-10-07 at 11 16 34 AM](https://user-images.githubusercontent.com/49927862/194600350-8131459e-cd91-4ac8-9fcc-3d1b2e491a1f.png)

You should now have this new databse listed on the left: ![Screen Shot 2022-10-07 at 11 12 52 AM](https://user-images.githubusercontent.com/49927862/194599628-952d61e7-1ab8-4c25-8aa2-a9883b9fe6bb.png)
You should now have this new database listed on the left: ![Screen Shot 2022-10-07 at 11 12 52 AM](https://user-images.githubusercontent.com/49927862/194599628-952d61e7-1ab8-4c25-8aa2-a9883b9fe6bb.png)