Skip to content

Commit ff73f51

Browse files
4lch4Irene Alvarado
authored andcommitted
chore(README): updated readme to include authorization header
1 parent 8168288 commit ff73f51

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Check out our [example repositories](https://github.com/githubocto?q=flat-demo&t
2929

3030
### Option 1: Flat Editor VSCode Extension
3131

32-
The easiest way to get a Flat Data action up and running is with the accompanying [Flat Editor VSCode Extension](https://marketplace.visualstudio.com/items?itemName=GitHubOCTO.flat) which helps you author Flat yml files.
32+
The easiest way to get a Flat Data action up and running is with the accompanying [Flat Editor VSCode Extension](https://marketplace.visualstudio.com/items?itemName=GitHubOCTO.flat) which helps you author Flat yml files.
3333

3434
To use it, [install the extension](https://marketplace.visualstudio.com/items?itemName=GitHubOCTO.flat) and then invoke `Flat Editor` from the command palette within VSCode (Mac: ⌘⇧P, Others:ctrl-shift-P).
3535

@@ -85,13 +85,25 @@ These two modes are exclusive; you cannot mix settings for these two in one Flat
8585

8686
#### `http_url`
8787

88-
A URL from which to fetch data. Specifying this input puts Flat into `http` mode.
88+
A URL from which to fetch data. Specifying this input puts Flat into `http` mode.
8989

9090
This can be any endpoint: a json, csv, png, zip, xlsx, etc.
9191

92+
#### `authorization` (optional)
93+
94+
A string used for authorizing the HTTP request. The value of this field is passed in as a header w/ the `authorization` key.
95+
96+
For example, if this field is set to `Bearer abc123` then the following header is sent with each request:
97+
98+
```json
99+
{
100+
"Authorization": "Bearer abc123"
101+
}
102+
```
103+
92104
#### `downloaded_filename`
93105

94-
The name of the file to store data fetched by Flat.
106+
The name of the file to store data fetched by Flat.
95107

96108
In `http` mode this can be anything. This can be any endpoint: a json, csv, txt, png, zip, xlsx, etc. file
97109

@@ -115,14 +127,13 @@ A URI-style database connection string. Flat will use this connection string to
115127
>
116128
> If you're using the [flat-vscode extension](https://github.com/githubocto/flat-vscode), this is handled for you.
117129

118-
119130
#### `sql_queryfile`
120131

121132
The pathname of the file containing the SQL query that will be issued to the database. Defaults to `.github/workflows/query.sql`. This path is relative to the root of your repo.
122133

123134
#### `downloaded_filename`
124135

125-
The name of the file to store data fetched by Flat.
136+
The name of the file to store data fetched by Flat.
126137

127138
In `sql` mode this should be one of `csv` or `json`. SQL query results will be serialized to disk in the specified format.
128139

0 commit comments

Comments
 (0)