Skip to content

Commit

Permalink
docs: support for Compute
Browse files Browse the repository at this point in the history
  • Loading branch information
Integralist committed Oct 27, 2023
1 parent 055d2fb commit 6775ff2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
15 changes: 15 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,18 @@
```bash
$ make all
```

## Compute

Support for the [Fastly Compute](https://www.fastly.com/products/edge-compute) platform is still in development.

There are known issues with the use of Go's `reflect` package (primarily due to the go-fastly API client internally using [github.com/mitchellh/mapstructure](https://github.com/mitchellh/mapstructure)) that still need to be addressed or for support to mature when using TinyGo.

If using standard Go (not TinyGo) then a usable client can be achieved with:

```go
client, err := fastly.NewClient("FASTLY_API_KEY")
client.HTTPClient.Transport = fsthttp.NewTransport("fastly")
```

This presumes you have a backend named `fastly` pointing to `https://api.fastly.com`
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

A Go client library for interacting with most facets of the [Fastly API](https://docs.fastly.com/api).

This library is not intended for use on the [Fastly Compute](https://www.fastly.com/products/edge-compute) platform.
> **NOTE:** This API client may not function correctly when used on the [Fastly Compute](https://www.fastly.com/products/edge-compute) platform. Support for Compute is on the roadmap but has not yet been prioritised ([details](./DEVELOPMENT.md#compute)).
## Usage

Expand Down

0 comments on commit 6775ff2

Please sign in to comment.