Skip to content
This repository has been archived by the owner on Jun 20, 2022. It is now read-only.

Commit

Permalink
fix: undo indentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@juliangoacher
juliangoacher committed Mar 6, 2020
1 parent 70e5e5a commit 471075d
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 42 deletions.
24 changes: 12 additions & 12 deletions packages/trail-fastify-graphql-plugin/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,37 +34,37 @@ Graphql queries can then be submitted to the `/graphql` path as either GET or PO

The plugin takes the following configuration options:

* `logger`: A logger to be passed to the trails manager.
* `db`: Database settings for the trails manager.
* `pool`: A pre-configured database pool to be used by the trails manager; used in preference to any specified database settings.
* `trailsManager`: A pre-configured trails manager instance; used in preference to any of the previous settings.
* `logger`: A logger to be passed to the trails manager.
* `db`: Database settings for the trails manager.
* `pool`: A pre-configured database pool to be used by the trails manager; used in preference to any specified database settings.
* `trailsManager`: A pre-configured trails manager instance; used in preference to any of the previous settings.

## Graphql schema

### Queries

The schema provides the following queries:

* `trail(id: Int!)`: Fetch a trail record by ID.
* `trails(from: Date!, to: Date!, ...)`: Search for trail records within a specified date range, and optionally filter by additional values.
* `enumerateTrails(from: Date!, to: Date!, type: TrailType!, ...)`: Return an enumeration of trails of the specified type, within the specified date range.
* `trail(id: Int!)`: Fetch a trail record by ID.
* `trails(from: Date!, to: Date!, ...)`: Search for trail records within a specified date range, and optionally filter by additional values.
* `enumerateTrails(from: Date!, to: Date!, type: TrailType!, ...)`: Return an enumeration of trails of the specified type, within the specified date range.

### Mutations

The schema provides the following mutations:

* `insertTrail(when: Date!, who: StringWithAttrs!, what: StringWithAttrs!, subject: StringWithAttrs!, where: JSON, why: JSON, meta: JSON)`: Insert a new trail record.
* `updateTrail(id: Int!, when: Date!, who: StringWithAttrs!, what: StringWithAttrs!, subject: StringWithAttrs!, where: JSON, why: JSON, meta: JSON)`: Update a trail record.
* `deleteTrail(id: Int!)`: Delete a trail record.
* `insertTrail(when: Date!, who: StringWithAttrs!, what: StringWithAttrs!, subject: StringWithAttrs!, where: JSON, why: JSON, meta: JSON)`: Insert a new trail record.
* `updateTrail(id: Int!, when: Date!, who: StringWithAttrs!, what: StringWithAttrs!, subject: StringWithAttrs!, where: JSON, why: JSON, meta: JSON)`: Update a trail record.
* `deleteTrail(id: Int!)`: Delete a trail record.

### String values

Some trail record fields support attributed string values (indicated by the `StringWithAttrs` type) when inserting or updating. When writing fields of this type, the value can be specified either as an object with an `id` property (specifying the string value) and additional properties which specify the string's attributes; or as a simple string value when no additional attributes are needed.

For example:

* String with attributes: `{ id: "the string", attr0: "this", attr1: 1 }`
* String with no attributes: `"the string"` - equivalent to `{ id: "the string" }`
* String with attributes: `{ id: "the string", attr0: "this", attr1: 1 }`
* String with no attributes: `"the string"` - equivalent to `{ id: "the string" }`

## Sample queries

Expand Down
8 changes: 4 additions & 4 deletions packages/trail-fastify-plugin/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ For more information on the REST API, you can check the generated OpenAPI / Swag

The plugin takes the following configuration options:

* `logger`: A logger to be passed to the trails manager.
* `db`: Database settings for the trails manager.
* `pool`: A pre-configured database pool to be used by the trails manager; used in preference to any specified database settings.
* `trailsManager`: A pre-configured trails manager instance; used in preference to any of the previous settings.
* `logger`: A logger to be passed to the trails manager.
* `db`: Database settings for the trails manager.
* `pool`: A pre-configured database pool to be used by the trails manager; used in preference to any specified database settings.
* `trailsManager`: A pre-configured trails manager instance; used in preference to any of the previous settings.

## License

Expand Down
44 changes: 22 additions & 22 deletions packages/trail-fastify-server/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,31 +26,31 @@ This will start a server on `localhost:8080`. Swagger UI documentation is access

The server looks for the following environment variables:

* `TRAIL_DB_HOST`: The hostname for the trail database.
* `TRAIL_DB_PORT`: The port number for the trail database.
* `TRAIL_DB_NAME`: The name of the trail database.
* `TRAIL_DB_USERNAME`: The username for the trail database.
* `TRAIL_DB_PASSWORD`: The password for the trail database.
* `TRAIL_DB_POOL_SIZE`: The size of the trail DB pool.
* `TRAIL_DB_TIMEOUT`: The trail database idle tieout, in milliseconds.
* `TRAIL_HTTP_HOST`: The hostname the HTTP server is bound to.
* `TRAIL_HTTP_PORT`: The port the HTTP server is bound to.
* `TRAIL_USE_REST_API`: Flag indicating whether to mount the REST API.
* `TRAIL_USE_GRAPHQL`: Flag indicating whether to mount the graphql endpoint.
* `TRAIL_DB_HOST`: The hostname for the trail database.
* `TRAIL_DB_PORT`: The port number for the trail database.
* `TRAIL_DB_NAME`: The name of the trail database.
* `TRAIL_DB_USERNAME`: The username for the trail database.
* `TRAIL_DB_PASSWORD`: The password for the trail database.
* `TRAIL_DB_POOL_SIZE`: The size of the trail DB pool.
* `TRAIL_DB_TIMEOUT`: The trail database idle tieout, in milliseconds.
* `TRAIL_HTTP_HOST`: The hostname the HTTP server is bound to.
* `TRAIL_HTTP_PORT`: The port the HTTP server is bound to.
* `TRAIL_USE_REST_API`: Flag indicating whether to mount the REST API.
* `TRAIL_USE_GRAPHQL`: Flag indicating whether to mount the graphql endpoint.

The server also takes the following command line options:

* `--dbHost`: The hostname for the trail database.
* `--dbPort`: The port number for the trail database.
* `--dbName`: The name of the trail database.
* `--dbUsername`: The username for the trail database.
* `--dbPassword`: The password for the trail database.
* `--dbPoolsize`: The size of the trail DB pool.
* `--dbTimeout`: The trail database idle tieout, in milliseconds.
* `--httpHost`: The hostname the HTTP server is bound to.
* `--httpPort`: The port the HTTP server is bound to.
* `--useRESTAPI`: Flag indicating whether to start with the Trail's REST API. Defaults to `true`.
* `--useGraphql`: Flag indicating whether to start with the graphql query endpoint. Defaults to `true`.
* `--dbHost`: The hostname for the trail database.
* `--dbPort`: The port number for the trail database.
* `--dbName`: The name of the trail database.
* `--dbUsername`: The username for the trail database.
* `--dbPassword`: The password for the trail database.
* `--dbPoolsize`: The size of the trail DB pool.
* `--dbTimeout`: The trail database idle tieout, in milliseconds.
* `--httpHost`: The hostname the HTTP server is bound to.
* `--httpPort`: The port the HTTP server is bound to.
* `--useRESTAPI`: Flag indicating whether to start with the Trail's REST API. Defaults to `true`.
* `--useGraphql`: Flag indicating whether to start with the graphql query endpoint. Defaults to `true`.

## License

Expand Down
8 changes: 4 additions & 4 deletions packages/trail-hapi-plugin/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ For more information on the REST API, you can check the generated OpenAPI / Swag

The plugin takes the following configuration options:

* `logger`: A logger to be passed to the trails manager.
* `db`: Database settings for the trails manager.
* `pool`: A pre-configured database pool to be used by the trails manager; used in preference to any specified database settings.
* `trailsManager`: A pre-configured trails manager instance; used in preference to any of the previous settings.
* `logger`: A logger to be passed to the trails manager.
* `db`: Database settings for the trails manager.
* `pool`: A pre-configured database pool to be used by the trails manager; used in preference to any specified database settings.
* `trailsManager`: A pre-configured trails manager instance; used in preference to any of the previous settings.

## License

Expand Down

0 comments on commit 471075d

Please sign in to comment.