Merge pull request #45 from yesjinu/docs/enhance-readme

docs: enhance README.md
This commit is contained in:
Frank Jogeleit 2022-05-24 13:25:37 +02:00 committed by GitHub
commit d4c0bee13c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -15,6 +15,8 @@ jobs:
method: 'POST' method: 'POST'
username: ${{ secrets.AWX_USER }} username: ${{ secrets.AWX_USER }}
password: ${{ secrets.AWX_PASSWORD }} password: ${{ secrets.AWX_PASSWORD }}
customHeaders: '{"Authorization": "Bearer ${{ secrets.TOKEN }}", "Content-Type": "application/json"}'
data: '{"key_1": "value_1", "key_2": "value_2"}'
``` ```
### Versioning ### Versioning
@ -46,7 +48,7 @@ jobs:
|---|---| |---|---|
`response` | Response as JSON String `response` | Response as JSON String
To display HTTP response data in the GitHub Actions log give the request an `id` and access its `outputs` To display HTTP response data in the GitHub Actions log give the request an `id` and access its `outputs`. You can also access specific field from the response data using [fromJson()](https://docs.github.com/en/actions/learn-github-actions/expressions#fromjson) expression.
```yaml ```yaml
steps: steps:
@ -56,7 +58,9 @@ steps:
with: with:
url: "http://yoursite.com/api" url: "http://yoursite.com/api"
- name: Show Response - name: Show Response
run: echo ${{ steps.myRequest.outputs.response }} run: |
echo ${{ steps.myRequest.outputs.response }}
echo ${{ fromJson(steps.myRequest.outputs.response).field_you_want_to_access }}
``` ```
### Additional Information ### Additional Information