You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-5Lines changed: 16 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Check out our [example repositories](https://github.com/githubocto?q=flat-demo&t
29
29
30
30
### Option 1: Flat Editor VSCode Extension
31
31
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.
33
33
34
34
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).
35
35
@@ -85,13 +85,25 @@ These two modes are exclusive; you cannot mix settings for these two in one Flat
85
85
86
86
#### `http_url`
87
87
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.
89
89
90
90
This can be any endpoint: a json, csv, png, zip, xlsx, etc.
91
91
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
+
92
104
#### `downloaded_filename`
93
105
94
-
The name of the file to store data fetched by Flat.
106
+
The name of the file to store data fetched by Flat.
95
107
96
108
In `http` mode this can be anything. This can be any endpoint: a json, csv, txt, png, zip, xlsx, etc. file
97
109
@@ -115,14 +127,13 @@ A URI-style database connection string. Flat will use this connection string to
115
127
>
116
128
> If you're using the [flat-vscode extension](https://github.com/githubocto/flat-vscode), this is handled for you.
117
129
118
-
119
130
#### `sql_queryfile`
120
131
121
132
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.
122
133
123
134
#### `downloaded_filename`
124
135
125
-
The name of the file to store data fetched by Flat.
136
+
The name of the file to store data fetched by Flat.
126
137
127
138
In `sql` mode this should be one of `csv` or `json`. SQL query results will be serialized to disk in the specified format.
0 commit comments