1
0
mirror of synced 2025-12-19 18:14:56 -05:00

[tools] prettier rules for .md + formatting cleanup

This commit is contained in:
Natik Gadzhi
2024-05-07 08:19:33 -07:00
committed by GitHub
parent 5432fab8af
commit cb80e6922a
1001 changed files with 17056 additions and 11500 deletions

View File

@@ -1,6 +1,7 @@
Scripts in this directory are for Airbyte's employees
# `demo.sh`
This script helps maintain Airbyte's demo instance:
```shell
@@ -9,6 +10,7 @@ This script helps maintain Airbyte's demo instance:
```
# `compare_versions.sh`
This script compare records output for two given connector versions
## Usage
@@ -21,19 +23,17 @@ Config, configured catalog and state files should be saved in `config_files` fol
config - `/config_files/secrets/config.json`
catalog - `/config_files/configured_catalog.json`
catalog - `/config_files/configured_catalog.json`
state - `/config_files/state.json` (only if you want start sync with state is required)
- Enter connector name: <conneector-name> [source-twitter]
- Enter first connector version: <first-conneector-version> [0.1.1]
- Enter second connector version: <second-conneector-version> [0.1.2]
- Start sync with state (y/n)? [y/n]
Depend on choose sync will be started with state or without.
State should be present in `/config_files/state.json` to start sync with state.
After 3 wrong tries process will be finished with 1.
Depend on choose sync will be started with state or without.
State should be present in `/config_files/state.json` to start sync with state.
After 3 wrong tries process will be finished with 1.
If comparing successful and script didn't find difference you get `Records output equal.`
Otherwise you get difference and `Records output not equal.`

View File

@@ -1,13 +1,17 @@
# openapi2jsonschema
Util for generating catalog schema from OpenAPI definition file. Forked from [openapi2jsonschema](https://github.com/instrumenta/openapi2jsonschema) util with fixes for generating standlone schemas e.g. ones that don't contain reference to other files/resources.
## Usage
```bash
$ tools/openapi2jsonschema/run.sh <path to OpenAPI definition file>
```
It would generate set of JSONSchema files based on components described on OpenAPI's definition and place it in "**schemas**" folder in the current working directory.
Support OpenAPI v2.0, v3.0 and v3.1. Works with both JSON and Yaml OpenAPI formats.
It would generate set of JSONSchema files based on components described on OpenAPI's definition and place it in "**schemas**" folder in the current working directory.
Support OpenAPI v2.0, v3.0 and v3.1. Works with both JSON and Yaml OpenAPI formats.
### Examples
You can try to run this tool on the sample OpenApi definition files located in [examples](./examples) directory. There are some OpenAPI files taken from APIs-guru repo [from github](https://github.com/APIs-guru).

View File

@@ -1,17 +1,21 @@
# Link Checker
Used to detect broken links in a domain.
To check docs:
```shell script
./tools/site/link_checker.sh check_docs
```
To run BLC:
```shell script
./tools/site/link_checker.sh run --help
```
To update the image:
```shell script
./tools/site/link_checker.sh publish
```
```