repo-mirrors/open-data-contract-standard
1
0
Fork 0
mirror of https://github.com/bitol-io/open-data-contract-standard.git synced 2025-05-28 19:34:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #116 from pflooky/add-common-server-doc

Browse Source 
Add in common server properties table in docs README
This commit is contained in:
Dr. Simon Harrer
2025-03-10 16:05:36 +01:00
committed by GitHub
parent f18beecf33 d6cd078767
commit 128e407b1c
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/README.md
View File

@@ -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
@@ -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