Skip to content

Commit

Permalink
Updated readme, prepare for 1.2.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
retrodaredevil committed Jun 30, 2024
1 parent 1c883d3 commit 12858be
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 22 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## 1.2.0

Merged [#5](https://github.com/wildmountainfarms/wild-graphql-datasource/pull/5)
which updates the internal libraries for better HTTP header support that can be configured within the data source itself.
Additionally, all GraphQL requests will include a `Accept: application/json` header in every request.
This additional header matches [the GraphQL over HTTP spec](https://graphql.github.io/graphql-over-http/draft/#sec-Accept) for better compatibility with GraphQL servers.

## 1.1.1

No new features or fixes.
Expand Down
20 changes: 1 addition & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,6 @@ Requests are made in the backend allowing support for alerting.

Please report issues on our issues page: [wild-graphql-datasource/issues](https://github.com/wildmountainfarms/wild-graphql-datasource/issues)

Contents

* [Features](#features)
* [Query Editor](#query-editor)
* [Query](#query)
* [Variables](#variables)
* [Parsing Options](#parsing-options)
* [Data path and time path](#data-path-and-time-path)
* [Labels](#labels)
* [The use of multiple parsing options](#the-use-of-multiple-parsing-options)
* [FAQ](#faq)
* [Common Errors](#common-errors)
* [Known Issues](#known-issues)


## Features

* Complex GraphQL responses can be turned into timeseries data, or a simple table
Expand All @@ -32,7 +17,7 @@ Contents
* Prettify the query with the click of a button
* `from` and `to` variables are given to the query via [native GraphQL variables](https://graphql.org/learn/queries/#variables)
* Variables section of the query editor supports interpolation of string values using [Grafana variables](https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/). (\*not supported in alerting or other backend-only queries)
* Multiple parsing options are supported allowing for a single GraphQL query to return many different data point with different formats.
* Multiple parsing options are supported allowing for a single GraphQL query to return many different data points with different formats.
* Each parsing option has its own labels, which can be populated by a field in the response. These labels are used to group the response into different data frames.
* Labels can be used to change the display name by using `${__field.labels["displayName"]}` under Standard options > Display name.
* This is a backend plugin, so alerting is supported
Expand Down Expand Up @@ -274,9 +259,6 @@ Remember that Grafana transformations are not the preferred way of doing this, a
* Is this a drop-in replacement for [fifemon-graphql-datasource](https://grafana.com/grafana/plugins/fifemon-graphql-datasource/)?
* No, but both data sources have similar goals and can be ported between with little effort.

## Common errors

This section documents errors that may be common

### Alerting Specific Errors

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "wild-graphql-datasource",
"version": "1.1.1",
"version": "1.2.0",
"description": "Grafana data source to interpret GraphQL query results as timeseries data",
"scripts": {
"build": "webpack -c ./.config/webpack/webpack.config.ts --env production",
Expand Down

0 comments on commit 12858be

Please sign in to comment.