diff --git a/docs/json_schemas/grafana_datasource_exchange/v0/provider.json b/docs/json_schemas/grafana_datasource_exchange/v0/provider.json index b90b11c8..05421a00 100644 --- a/docs/json_schemas/grafana_datasource_exchange/v0/provider.json +++ b/docs/json_schemas/grafana_datasource_exchange/v0/provider.json @@ -8,11 +8,12 @@ "GrafanaDatasource": { "properties": { "type": { - "description": "Type of the datasource.", + "description": "Type of the datasource, typically one of https://grafana.com/docs/grafana/latest/datasources/#built-in-core-data-sources.", "examples": [ "tempo", "loki", - "prometheus" + "prometheus", + "elasticsearch" ], "title": "Type", "type": "string" diff --git a/docs/json_schemas/grafana_datasource_exchange/v0/requirer.json b/docs/json_schemas/grafana_datasource_exchange/v0/requirer.json index 7f1488f9..8a730dcf 100644 --- a/docs/json_schemas/grafana_datasource_exchange/v0/requirer.json +++ b/docs/json_schemas/grafana_datasource_exchange/v0/requirer.json @@ -8,11 +8,12 @@ "GrafanaDatasource": { "properties": { "type": { - "description": "Type of the datasource.", + "description": "Type of the datasource, typically one of https://grafana.com/docs/grafana/latest/datasources/#built-in-core-data-sources.", "examples": [ "tempo", "loki", - "prometheus" + "prometheus", + "elasticsearch" ], "title": "Type", "type": "string" diff --git a/interfaces/grafana_datasource_exchange/v0/README.md b/interfaces/grafana_datasource_exchange/v0/README.md index ff1a24f8..0a7939ec 100644 --- a/interfaces/grafana_datasource_exchange/v0/README.md +++ b/interfaces/grafana_datasource_exchange/v0/README.md @@ -30,8 +30,8 @@ The requirer and the provider need to adhere to a certain set of criteria to be - Is expected to register each datasource endpoint (one per unit) with a central grafana application and obtain a Datasource UID for each one of them. - Is expected to share via application data, as a json-encoded array (sorted by UID), the following information: - for each datasource (which technically will likely mean, for each unit of the application): - - the datasource UID - - the datasource type + - the datasource UID: an arbitrary string, that is expected to be unique for the grafana instance + - the datasource type: a grafana datasource type name (typically will be [one of the built-in ones](https://grafana.com/docs/grafana/latest/datasources/#built-in-core-data-sources)) To avoid complexity, we stipulate that the data will be provided in bulk: only 'fully specified' datasources will be shared, i.e. this is not a valid databag state: diff --git a/interfaces/grafana_datasource_exchange/v0/schema.py b/interfaces/grafana_datasource_exchange/v0/schema.py index ad469ffc..0be7cb66 100644 --- a/interfaces/grafana_datasource_exchange/v0/schema.py +++ b/interfaces/grafana_datasource_exchange/v0/schema.py @@ -5,8 +5,9 @@ class GrafanaDatasource(BaseModel): - type: str = Field(description="Type of the datasource.", - examples=['tempo', 'loki', 'prometheus']) + type: str = Field(description="Type of the datasource, typically one of " + "https://grafana.com/docs/grafana/latest/datasources/#built-in-core-data-sources.", + examples=["tempo", "loki", "prometheus", "elasticsearch"]) uid: str = Field(description="Grafana datasource UID, as assigned by Grafana.")