Skip to content

Commit

Permalink
Make spec storybook more prominent in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sherifnada authored Sep 29, 2021
1 parent 501d07f commit c5e74cf
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Connector Specification Reference
The [connector specification](../understanding-airbyte/airbyte-specification.md#spec) describes what inputs can be used to configure a connector. Like the rest of the Airbyte Protocol, it uses [JsonSchema](https://json-schema.org), but with some slight modifications.

{% hint style="info" %}
## Demoing your specification
While iterating on your specification, you can preview what it will look like in the UI in realtime by following the instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-webapp/docs/HowTo-ConnectionSpecification.md).
{% endhint %}


### Secret obfuscation
By default, any fields in a connector's specification are visible can be read in the UI. However, if you want to obfuscate fields in the UI and API (for example when working with a password), add the `airbyte_secret` annotation to your connector's `spec.json` e.g:
Expand Down

0 comments on commit c5e74cf

Please sign in to comment.