From fe1f6e48ba329a6988c57a5390c57abdcd4a44aa Mon Sep 17 00:00:00 2001 From: Eric Searcy Date: Fri, 6 Oct 2023 13:17:00 -0700 Subject: [PATCH] Update docs: fix broken markdown Signed-off-by: Eric Searcy --- README.md | 8 ++++---- SECURITY.md | 2 +- package.json | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 62dcd05..e2a90cf 100644 --- a/README.md +++ b/README.md @@ -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 --- @@ -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. diff --git a/SECURITY.md b/SECURITY.md index fa8f224..c1c70c5 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -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). diff --git a/package.json b/package.json index 25b4c8b..fb62ee6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "lowdefy-plugin-axios-oauth2-client-credentials", - "version": "1.0.0", + "version": "0.1.0", "license": "MIT", "type": "module", "exports": {