Skip to content

Commit

Permalink
Prettier Format
Browse files Browse the repository at this point in the history
  • Loading branch information
smashedr committed Sep 26, 2024
1 parent 0306dea commit 139ffab
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 51 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/mirror.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ jobs:
uses: cssnr/mirror-repository-action@master
with:
host: https://codeberg.org
username: shaner
create: true
username: "shaner"
password: ${{ secrets.CODEBERG_TOKEN }}
100 changes: 50 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,31 @@

# Web Request Action

* [Inputs](#Inputs)
* [Outputs](#Outputs)
* [Examples](#Examples)
* [Support](#Support)
* [Contributing](#Contributing)
* [Development](#Development)
- [Inputs](#Inputs)
- [Outputs](#Outputs)
- [Examples](#Examples)
- [Support](#Support)
- [Contributing](#Contributing)
- [Development](#Development)

> [!NOTE]
> Please submit a [Feature Request](https://github.com/cssnr/web-request-action/discussions/categories/feature-requests)
> for new features or [Open an Issue](https://github.com/cssnr/web-request-action/issues) if you find any bugs.
## Inputs

| input | required | default | description |
|----------|----------|---------|---------------------------|
| url | **Yes** | - | URL for Request |
| method | No | `POST` | Request Method |
| data | No | - | Request Data JSON * |
| headers | No | - | Request Headers JSON |
| params | No | - | Request Parameters JSON * |
| username | No | - | Basic Auth Username |
| password | No | - | Basic Auth Password |
| insecure | No | `false` | Ignore SSL Errors |
| file | No | - | File Path to Send * |
| name | No | `file` | File Form Key Name |
| input | required | default | description |
| -------- | -------- | ------- | -------------------------- |
| url | **Yes** | - | URL for Request |
| method | No | `POST` | Request Method |
| data | No | - | Request Data JSON \* |
| headers | No | - | Request Headers JSON |
| params | No | - | Request Parameters JSON \* |
| username | No | - | Basic Auth Username |
| password | No | - | Basic Auth Password |
| insecure | No | `false` | Ignore SSL Errors |
| file | No | - | File Path to Send \* |
| name | No | `file` | File Form Key Name |

**data** - Only used for `PUT`, `POST`, `DELETE`, and `PATCH`. Data is parsed with `JSON.parse`.

Expand All @@ -45,28 +45,28 @@ key `name`. The file path is relative to the workspace/working directory.
For more information on inputs, see: https://axios-http.com/docs/req_config

```yaml
- name: "Web Request"
uses: cssnr/web-request-action@master
with:
- name: 'Web Request'
uses: cssnr/web-request-action@master
with:
url: https://httpbin.org/post
```
## Outputs
| output | description |
|--------|-----------------|
| ------ | --------------- |
| status | Response Status |
| data | Response Data |
```yaml
- name: "Web Request"
id: test
uses: cssnr/web-request-action@master
with:
- name: 'Web Request'
id: test
uses: cssnr/web-request-action@master
with:
url: https://httpbin.org/post

- name: "Echo Output"
run: |
- name: 'Echo Output'
run: |
echo '${{ steps.test.outputs.status }}'
echo '${{ steps.test.outputs.data }}'
```
Expand All @@ -86,31 +86,31 @@ Make a GET Request:
Send Data:
```yaml
- name: "Web Request"
uses: cssnr/web-request-action@master
with:
- name: 'Web Request'
uses: cssnr/web-request-action@master
with:
url: https://httpbin.org/post
data: '{"key": "value"}'
```
Send File:
```yaml
- name: "Web Request"
uses: cssnr/web-request-action@master
with:
- name: 'Web Request'
uses: cssnr/web-request-action@master
with:
url: https://httpbin.org/post
file: path/to/file.txt
```
All Inputs:
```yaml
- name: "Web Request"
uses: cssnr/web-request-action@master
with:
- name: 'Web Request'
uses: cssnr/web-request-action@master
with:
url: https://httpbin.org/post
method: "POST"
method: 'POST'
data: '{"key": "value"}'
headers: '{"header": "value"}'
params: '{"parameter": "value"}'
Expand All @@ -127,28 +127,28 @@ More Examples Coming Soon...
For general help or to request a feature, see:
- Q&A Discussion: https://github.com/cssnr/web-request-action/discussions/categories/q-a
- Request a Feature: https://github.com/cssnr/web-request-action/discussions/categories/feature-requests
- Q&A Discussion: https://github.com/cssnr/web-request-action/discussions/categories/q-a
- Request a Feature: https://github.com/cssnr/web-request-action/discussions/categories/feature-requests
If you are experiencing an issue/bug or getting unexpected results, you can:
- Report an Issue: https://github.com/cssnr/web-request-action/issues
- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
- Provide General
Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Web%20Request%20Action)
- Report an Issue: https://github.com/cssnr/web-request-action/issues
- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
- Provide General
Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Web%20Request%20Action)
# Contributing
Currently, the best way to contribute to this project is to star this project on GitHub.
Additionally, you can support other GitHub Actions I have published:
- [VirusTotal Action](https://github.com/cssnr/virustotal-action)
- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action)
- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action)
- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action)
- [Portainer Stack Deploy](https://github.com/cssnr/portainer-stack-deploy-action)
- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action)
- [VirusTotal Action](https://github.com/cssnr/virustotal-action)
- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action)
- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action)
- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action)
- [Portainer Stack Deploy](https://github.com/cssnr/portainer-stack-deploy-action)
- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action)
For a full list of current projects to support visit: [https://cssnr.github.io/](https://cssnr.github.io/)
Expand Down

0 comments on commit 139ffab

Please sign in to comment.