Skip to content

Commit

Permalink
Update docs: fix broken markdown
Browse files Browse the repository at this point in the history
Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
  • Loading branch information
emsearcy committed Oct 6, 2023
1 parent 407faf7 commit fe1f6e4
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ This repository is a Lowdefy 4 plugin that provides a new Connection, axios-oaut

## Usage

This plugin is not released to any NPM repositories as a package. Rather, it is expected to be added to a Lowdefy monorepo under the plugins/ folder (e.g. using Git submodules). For more information on Lowdefy monorepos, please read the documentation for at (lowdefy-example-plugins)[https://github.com/lowdefy/lowdefy-example-plugins]. For more information on Git submodules, please refer to (Pro Git)[https://git-scm.com/book/en/v2/Git-Tools-Submodules].
This plugin is not released to any NPM repositories as a package. Rather, it is expected to be added to a Lowdefy monorepo under the plugins/ folder (e.g. using Git submodules). For more information on Lowdefy monorepos, please read the documentation for at [lowdefy-example-plugins](https://github.com/lowdefy/lowdefy-example-plugins). For more information on Git submodules, please refer to [Pro Git](https://git-scm.com/book/en/v2/Git-Tools-Submodules).

### Example

**auth.tokenUrl**, **auth.clientId**, and **auth.clientSecret** are REQUIRED parameters for the connection. **auth.endpointParams** is optional.

### Example
The OAuth2 client\_credentials configuration MUST be on the connection definition, not the request.

```yaml
---
Expand Down Expand Up @@ -60,8 +62,6 @@ pages:
url: /hello
```
The OAuth2 client\_credentials configuration MUST be on the connection definition, not in the request.
## Design
This plugin is built on top of the existing Lowdefy Axios Connection, and extends its schema and its methods. Notably, the `auth` attribute of the connection (_not_ the request) is repurposed from being used to configure HTTP Basic authorization, and instead is used to configure the Client Credentials Grant token request.
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
To report a security vulnerability, please use GitHub's feature for private
security reporting.

For more information, please visit [How to report vulnerabilities to LF projects
For more information, please read: [How to report vulnerabilities to LF projects
and foundations](https://www.linuxfoundation.org/security).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "lowdefy-plugin-axios-oauth2-client-credentials",
"version": "1.0.0",
"version": "0.1.0",
"license": "MIT",
"type": "module",
"exports": {
Expand Down

0 comments on commit fe1f6e4

Please sign in to comment.