For an adapter to be supported on the Market, it needs a configuration file that describes and species the adapter to be committed into the repository.
- Visibly Public Repository: No private GitHub repositories or forked repositories can be added.
- Adapter Configuration: Repository has a committed
.adapter.ymlfile in any folder or with any filename matching to the schema described below.
Full example (.adapter.yml):
name: Example description: An example adapter that does something. node_identifier: example platforms: - Docker - AWS Lambda - GCP Functions data_sources: - name: Example url: https://example.com parameters: - base - quote
|name||string||The publicly visible name/title of the adapter when listed on the Market. This will show as the title in all pages & search results.|
|node_identifier||string||The ID of the adapter on Chainlink nodes. This is what is used within |
|description||string||The publicly visible description of the adapter that is shown within search results and when viewing.|
|platforms||string||The list of platforms that your adapter supports. Currently only: |
|data_sources.name||string||The name of that datasource. This is used to match any pre-existing data sources. For example, if you name your data source |
|data_sources.url||string||Valid URL||The URL of the datasource. We recommend this be the homepage of the service in question, or the landing page for the API documentation.|
|parameters||string||The list of parameters for your adapter. These parameters will be shown to the node operators/users when using your adapter. For example, when creating a job if you select an added adapter, it will show the list of parameter keys as designated by this field.|