@saishnarvekar/plugin-elastic-devtool-backend 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -12
- package/package.json +17 -8
package/README.md
CHANGED
|
@@ -7,14 +7,10 @@ developing the plugin backend itself.
|
|
|
7
7
|
> [!TIP]
|
|
8
8
|
> Backend API for Elasticsearch management and query in Backstage.
|
|
9
9
|
|
|
10
|
-
---
|
|
11
|
-
|
|
12
10
|
## Overview
|
|
13
11
|
|
|
14
12
|
`@saishnarvekar/plugin-elastic-devtool-backend` provides the backend API and service layer for the Elastic Dev Tool plugin, enabling secure, robust Elasticsearch operations from your Backstage instance.
|
|
15
13
|
|
|
16
|
-
---
|
|
17
|
-
|
|
18
14
|
## Features
|
|
19
15
|
|
|
20
16
|
- REST API for Elasticsearch query and index management
|
|
@@ -22,7 +18,13 @@ developing the plugin backend itself.
|
|
|
22
18
|
- Cluster health and stats endpoints
|
|
23
19
|
- Built with Backstage backend best practices
|
|
24
20
|
|
|
25
|
-
|
|
21
|
+
### Screenshots
|
|
22
|
+
|
|
23
|
+
**Home Interface**
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
**Table Results View**
|
|
27
|
+
|
|
26
28
|
|
|
27
29
|
## Installation
|
|
28
30
|
|
|
@@ -32,8 +34,6 @@ Add the backend plugin to your Backstage backend:
|
|
|
32
34
|
yarn --cwd packages/backend add @saishnarvekar/plugin-elastic-devtool-backend
|
|
33
35
|
```
|
|
34
36
|
|
|
35
|
-
---
|
|
36
|
-
|
|
37
37
|
## Usage
|
|
38
38
|
|
|
39
39
|
Register the plugin in your backend (e.g. in `packages/backend/src/index.ts`):
|
|
@@ -56,8 +56,6 @@ elastic-devtool:
|
|
|
56
56
|
password: 'password' # optional
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
---
|
|
60
|
-
|
|
61
59
|
## Development
|
|
62
60
|
|
|
63
61
|
To run the backend plugin in isolation for development:
|
|
@@ -68,8 +66,6 @@ yarn start
|
|
|
68
66
|
|
|
69
67
|
This will launch a local backend server for rapid development and testing.
|
|
70
68
|
|
|
71
|
-
---
|
|
72
|
-
|
|
73
69
|
## Resources
|
|
74
70
|
|
|
75
71
|
- [Backstage Backend Plugins](https://backstage.io/docs/backend-system/)
|
|
@@ -79,4 +75,4 @@ This will launch a local backend server for rapid development and testing.
|
|
|
79
75
|
---
|
|
80
76
|
|
|
81
77
|
> [!IMPORTANT]
|
|
82
|
-
> Use together with [`@saishnarvekar/plugin-elastic-devtool`](
|
|
78
|
+
> Use together with [`@saishnarvekar/plugin-elastic-devtool`](https://www.npmjs.com/package/@saishnarvekar/plugin-elastic-devtool) for a complete frontend + backend solution.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@saishnarvekar/plugin-elastic-devtool-backend",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"main": "dist/index.cjs.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -30,11 +30,11 @@
|
|
|
30
30
|
"postpack": "backstage-cli package postpack"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@backstage/backend-defaults": "^0.
|
|
34
|
-
"@backstage/backend-plugin-api": "^1.
|
|
35
|
-
"@backstage/catalog-client": "^1.
|
|
36
|
-
"@backstage/errors": "^1.
|
|
37
|
-
"@backstage/plugin-catalog-node": "^
|
|
33
|
+
"@backstage/backend-defaults": "^0.17.4",
|
|
34
|
+
"@backstage/backend-plugin-api": "^1.9.2",
|
|
35
|
+
"@backstage/catalog-client": "^1.16.0",
|
|
36
|
+
"@backstage/errors": "^1.3.1",
|
|
37
|
+
"@backstage/plugin-catalog-node": "^2.2.2",
|
|
38
38
|
"@backstage/types": "^1.2.2",
|
|
39
39
|
"@elastic/elasticsearch": "^9.2.0",
|
|
40
40
|
"express": "^4.17.1",
|
|
@@ -42,8 +42,8 @@
|
|
|
42
42
|
"zod": "^3.22.4"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
|
-
"@backstage/backend-test-utils": "^1.
|
|
46
|
-
"@backstage/cli": "^0.
|
|
45
|
+
"@backstage/backend-test-utils": "^1.11.4",
|
|
46
|
+
"@backstage/cli": "^0.36.3",
|
|
47
47
|
"@types/express": "^4.17.6",
|
|
48
48
|
"@types/supertest": "^2.0.12",
|
|
49
49
|
"supertest": "^6.2.4"
|
|
@@ -51,6 +51,15 @@
|
|
|
51
51
|
"files": [
|
|
52
52
|
"dist"
|
|
53
53
|
],
|
|
54
|
+
"repository": {
|
|
55
|
+
"type": "git",
|
|
56
|
+
"url": "git+https://github.com/SaishNarvekar/elastic-devtool.git"
|
|
57
|
+
},
|
|
58
|
+
"keywords": [
|
|
59
|
+
"backstage",
|
|
60
|
+
"backstage-plugin",
|
|
61
|
+
"elasticsearch"
|
|
62
|
+
],
|
|
54
63
|
"typesVersions": {
|
|
55
64
|
"*": {
|
|
56
65
|
"package.json": [
|