Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change: documentation fix bearer.token property #865

Merged
merged 4 commits into from
Jun 3, 2024
Merged

change: documentation fix bearer.token property #865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2b681ee
docs: fix bearer.token property
matthias-pichler May 30, 2024
97de739
docs: add bearer auth example
matthias-pichler Jun 3, 2024
3dee2ed
fix: update bearer auth reference in table
matthias-pichler Jun 3, 2024
c9c689c
fix: remove duplicate bearer entry in table
matthias-pichler Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions dsl-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1015,10 +1015,10 @@ Defines the mechanism used to authenticate users and workflows attempting to acc
| Property | Type | Required | Description |
|----------|:----:|:--------:|-------------|
| basic | [`basicAuthentication`](#basic-authentication) | `no` | The `basic` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| bearer | [`basicAuthentication`](#bearer-authentication) | `no` | The `bearer` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| bearer | [`bearerAuthentication`](#bearer-authentication) | `no` | The `bearer` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| certificate | [`certificateAuthentication`](#certificate-authentication) | `no` | The `certificate` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| digest | [`digestAuthentication`](#digest-authentication) | `no` | The `digest` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| bearer | [`oauth2`](#oauth2-authentication) | `no` | The `oauth2` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
| oauth2 | [`oauth2`](#oauth2-authentication) | `no` | The `oauth2` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |

##### Examples

Expand Down Expand Up @@ -1087,7 +1087,7 @@ Defines the fundamentals of a 'bearer' authentication

| Property | Type | Required | Description |
|----------|:----:|:--------:|-------------|
| bearer | `string` | `yes` | The bearer token to use. |
| token | `string` | `yes` | The bearer token to use. |

##### Examples

Expand Down
15 changes: 15 additions & 0 deletions examples/bearer-auth.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
document:
dsl: 1.0.0-alpha1
namespace: examples
name: bearer-auth
version: 1.0.0-alpha1
do:
getPetById:
call: http
with:
method: get
endpoint:
uri: https://petstore.swagger.io/v2/pet/{petId}
authentication:
bearer:
token: ${ .token }
Loading