finished http package, resolves #389

pull/430/head
Scott Anderson 2019-09-04 11:46:03 -06:00
parent 40b6ef86a2
commit ebc0ec00e4
3 changed files with 64 additions and 5 deletions

View File

@ -2,7 +2,7 @@
title: Flux HTTP package
list_title: HTTP package
description: >
The Flux HTTP package provides functions ...
The Flux HTTP package provides functions for transferring data using the HTTP protocol.
Import the `http` package.
menu:
v2_0_ref:
@ -12,7 +12,7 @@ weight: 202
v2.0/tags: [functions, http, package]
---
The Flux HTTP package provides functions ...
The Flux HTTP package provides functions for transferring data using the HTTP protocol.
Import the `http` package:
```js

View File

@ -0,0 +1,58 @@
---
title: http.endpoint() function
description: >
The `http.endpoint()` function sends output data to a an HTTP URL using the POST request method.
menu:
v2_0_ref:
name: http.endpoint
parent: HTTP
weight: 202
---
The `http.endpoint()` function sends output data to a an HTTP URL using the POST request method.
_**Function type:** Output_
```js
import "http"
http.endpoint(
url: "http://localhost:1234/"
)
```
## Parameters
### url
The URL to POST to.
_**Data type:** String_
### mapFn
A function that builds the object used to generate the POST request.
The object must include `headers` and `data` key-value pairs.
_For more information, see [`http.post()`](/v2.0/reference/flux/functions/http/post/)_
{{% note %}}
_You should rarely need to override the default `mapFn` parameter.
To see the default `mapFn` value or for insight into possible overrides, view the
[`http.endpoint()` source code](https://github.com/influxdata/flux/blob/master/stdlib/http/http.flux)._
{{% /note %}}
_**Data type:** Function_
## Examples
##### Send critical statuses to an HTTP endpoint
```js
import "monitor"
import "http"
endpoint = http.endpoint(url: "http://myawsomeurl.com/api/notify")
from(bucket: "example-bucket")
|> range(start: -1m)
|> filter(fn: (r) => r._measurement == "statuses" and status == "crit")
|> map(fn: (r) => { return {status: r._status} })
|> monitor.notify(endpoint: endpoint)
```

View File

@ -1,7 +1,8 @@
---
title: http.post() function
description: The `http.post()` function submits an HTTP POST request to the specified URL with headers and data.
// The HTTP status code is returned.
description: >
The `http.post()` function submits an HTTP POST request to the specified URL with headers and data.
The HTTP status code is returned.
menu:
v2_0_ref:
name: http.post
@ -43,7 +44,7 @@ _**Data type:** Bytes_
## Examples
### ...
##### Send the last reported status to a URL
```js
import "json"
import "http"