Skip to content

Add in common server properties table in docs README #116

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 10, 2025
Merged

Add in common server properties table in docs README #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -722,7 +722,8 @@ Each server in the schema has the following structure:

```yaml
servers:
- type: <server-type>
- server: my-server-name
type: <server-type>
description: <server-description>
environment: <server-environment>
<server-type-specific-fields> # according to the server type
Expand All @@ -734,11 +735,14 @@ servers:

#### Common Server Properties

- **type**: The type of server. Valid values include various server technologies like `athena`, `bigquery`, `postgresql`, etc.
- **description**: A description of the server.
- **environment**: The environment where the server operates (e.g., `prod`, `dev`, `uat`). There are no set values.
- **roles**: An optional array of roles that have access to the server.
- **customProperties**: Any additional custom properties specific to the server that are not part of the standard.
| Key | UX label | Required | Description |
|------------------|-------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| server | Server | Yes | Identifier of the server. |
| type | Type | Yes | Type of the server. Can be one of: api, athena, azure, bigquery, clickhouse, databricks, denodo, dremio, duckdb, glue, cloudsql, db2, informix, kafka, kinesis, local, mysql, oracle, postgresql, postgres, presto, pubsub, redshift, s3, sftp, snowflake, sqlserver, synapse, trino, vertica, custom. |
| description | Description | No | Description of the server. |
| environment | Environment | No | Environment of the server. Examples includes: prod, preprod, dev, uat. |
| roles | Roles | No | List of roles that have access to the server. Check [roles](#roles) section for more details. |
| customProperties | Custom Properties | No | Custom properties that are not part of the standard. |

### Specific Server Properties

Expand Down