Update readme and mark pre-bundled kong plugins as unlisted from plugin hub (#4164)

This commit is contained in:
Opender Singh
2021-11-10 20:42:41 +13:00
committed by GitHub
parent 8e21f26175
commit fc4f324ba1
6 changed files with 9 additions and 56 deletions

View File

@@ -4,22 +4,4 @@
This is a plugin for [Insomnia](https://insomnia.rest) to add the ability to generate Kong Declarative Config.
## Installation
Install the `insomnia-plugin-kong-declarative-config` plugin from Preferences > Plugins.
![plugins](./assets/plugins.png)
## Usage
Once this plugin is installed, open a document with an OpenAPI specification and navigate to the `Design` view.
If installed correctly, a button titled `Generate Config` will appear in the header (you may need to reopen the document).
![generate config](./assets/generateConfig.png)
Click on this button to open a modal, showing all of the config generator plugins installed and their output. From here, you can copy the config to your clipboard and execute on your platform.
![modal](./assets/modal.png)
This config will regenerate each time you click on the button, so that changes in your specification are included.
This plugin is pre-installed within Insomnia, and usage documentation can be found [here](https://docs.insomnia.rest/insomnia/declarative-config).

View File

@@ -14,7 +14,8 @@
},
"insomnia": {
"name": "kong-declarative-config",
"description": "Generate Kong Declarative Config"
"description": "Generate Kong Declarative Config",
"unlisted": true
},
"dependencies": {
"openapi-2-kong": "2.4.0",

View File

@@ -4,20 +4,4 @@
This is a plugin for [Insomnia](https://insomnia.rest) to add the ability to generate Kong for Kubernetes Config.
## Installation
Install the `insomnia-plugin-kong-kubernetes-config` plugin from Preferences > Plugins.
![plugins](./assets/plugins.png)
## Usage
Once this plugin is installed, open a document with an OpenAPI specification and navigate to the `Design` view.
If installed correctly, a button titled `Generate Config` will appear in the header (you may need to reopen the document).
![generate config](./assets/generateConfig.png)
Click on this button to open a modal, showing all of the config generator plugins installed and their output. From here, you can copy the config to your clipboard and execute on your platform. This config will regenerate each time you click on the button, so that changes in your specification are included.
![modal](./assets/modal.png)
This plugin is pre-installed within Insomnia, and usage documentation can be found [here](https://docs.insomnia.rest/insomnia/kong-for-kubernetes).

View File

@@ -14,7 +14,8 @@
},
"insomnia": {
"name": "kong-kubernetes-config",
"description": "Generate Kong For Kubernetes configuration"
"description": "Generate Kong For Kubernetes configuration",
"unlisted": true
},
"dependencies": {
"openapi-2-kong": "2.4.0",

View File

@@ -4,20 +4,4 @@
This is a plugin for [Insomnia](https://insomnia.rest) to add the ability to deploy API specifications to Kong Portal.
## Installation
Install the `insomnia-plugin-kong-portal` plugin from Preferences > Plugins.
![plugins](./assets/plugins.png)
## Usage
Once this plugin is installed, navigate to the homepage and click `...` to open the menu for a document.
If installed correctly, an option titled `Deploy to Dev Portal` will appear.
![dropdown](./assets/dropdown.png)
Click on this button and enter your URL, workspace name and RBAC token in order to connect to Kong.
![connect](assets/connect.png)
This plugin is pre-installed within Insomnia, and usage documentation can be found [here](https://docs.insomnia.rest/insomnia/publish-to-dev-portal).

View File

@@ -19,7 +19,8 @@
},
"insomnia": {
"name": "kong-portal",
"description": "Deploy API specifications to Kong Portal"
"description": "Deploy API specifications to Kong Portal",
"unlisted": true
},
"devDependencies": {
"@babel/core": "^7.9.0",