@abitechdev/openchasqui-validator-policies 0.1.0 → 0.1.1
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 +52 -7
- package/package.json +9 -2
package/README.md
CHANGED
|
@@ -1,12 +1,57 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://github.com/abitech-dev/abitech-openchasqui-cli#readme"><img alt="OpenChasqui" src="https://raw.githubusercontent.com/abitech-dev/abitech-openchasqui-cli/main/.github/assets/logo-light.svg" width="320"></a>
|
|
3
|
+
</p>
|
|
4
|
+
|
|
1
5
|
# @abitechdev/openchasqui-validator-policies
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
[](https://www.npmjs.com/package/@abitechdev/openchasqui-validator-policies)
|
|
8
|
+
[](https://github.com/abitech-dev/abitech-openchasqui-cli/actions/workflows/ci.yml)
|
|
9
|
+
[](https://github.com/abitech-dev/abitech-openchasqui-cli/blob/main/LICENSE)
|
|
10
|
+
|
|
11
|
+
Políticas de seguridad y calidad para las colecciones. Un error detiene `generate` y `verify`; una advertencia solo se informa.
|
|
12
|
+
|
|
13
|
+
> **¿Solo quieres generar colecciones?** Instala el CLI,
|
|
14
|
+
> [`@abitechdev/openchasqui`](https://www.npmjs.com/package/@abitechdev/openchasqui), que ya incluye este paquete.
|
|
15
|
+
|
|
16
|
+
## Instalación
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm i @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-bruno @abitechdev/openchasqui-validator-policies
|
|
20
|
+
pnpm add @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-bruno @abitechdev/openchasqui-validator-policies
|
|
21
|
+
yarn add @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-bruno @abitechdev/openchasqui-validator-policies
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Requiere Node.js 22 o superior.
|
|
25
|
+
|
|
26
|
+
## Uso
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import { readFile } from "node:fs/promises";
|
|
30
|
+
import { run } from "@abitechdev/openchasqui-core";
|
|
31
|
+
import { openApiLoader } from "@abitechdev/openchasqui-loader-openapi";
|
|
32
|
+
import { brunoEmitter } from "@abitechdev/openchasqui-emitter-bruno";
|
|
33
|
+
import { policiesValidator } from "@abitechdev/openchasqui-validator-policies";
|
|
34
|
+
|
|
35
|
+
const result = await run(
|
|
36
|
+
{ version: 1, source: "openapi.yaml", targets: ["bruno"], output: "collections" },
|
|
37
|
+
{
|
|
38
|
+
reader: { readText: (path) => readFile(path, "utf8") },
|
|
39
|
+
plugins: [openApiLoader, policiesValidator, brunoEmitter],
|
|
40
|
+
},
|
|
41
|
+
);
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
| Regla | Severidad | Cuándo |
|
|
45
|
+
| ------------------------ | ----------- | ---------------------------------------------------------- |
|
|
46
|
+
| `no-secrets-in-examples` | error | Un ejemplo contiene un JWT, una clave de nube o un token |
|
|
47
|
+
| `reserved-email-domains` | advertencia | Un correo de ejemplo no usa `example.com` u otro reservado |
|
|
48
|
+
| `success-response` | advertencia | Una operación no documenta ninguna respuesta 2xx |
|
|
49
|
+
| `public-write` | advertencia | Una operación de escritura no pide autenticación |
|
|
50
|
+
|
|
51
|
+
## Documentación
|
|
4
52
|
|
|
5
|
-
|
|
6
|
-
([en español](https://github.com/abitech-dev/abitech-openchasqui-cli#readme)), which generates API collections from
|
|
7
|
-
OpenAPI. Most projects only need the command line,
|
|
8
|
-
[`@abitechdev/openchasqui`](https://www.npmjs.com/package/@abitechdev/openchasqui).
|
|
53
|
+
[Español](https://github.com/abitech-dev/abitech-openchasqui-cli#readme) · [English](https://github.com/abitech-dev/abitech-openchasqui-cli/blob/main/README.en.md)
|
|
9
54
|
|
|
10
|
-
##
|
|
55
|
+
## Licencia
|
|
11
56
|
|
|
12
|
-
Apache-2.0
|
|
57
|
+
[Apache-2.0](https://github.com/abitech-dev/abitech-openchasqui-cli/blob/main/LICENSE). Parte de [OpenChasqui](https://github.com/abitech-dev/abitech-openchasqui-cli).
|
package/package.json
CHANGED
|
@@ -1,7 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@abitechdev/openchasqui-validator-policies",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Security and quality policies for API collections: secrets, real-looking data and untestable operations.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"openapi",
|
|
7
|
+
"api-security",
|
|
8
|
+
"linter",
|
|
9
|
+
"policies",
|
|
10
|
+
"openchasqui"
|
|
11
|
+
],
|
|
5
12
|
"license": "Apache-2.0",
|
|
6
13
|
"type": "module",
|
|
7
14
|
"exports": {
|
|
@@ -24,6 +31,6 @@
|
|
|
24
31
|
"directory": "packages/validator-policies"
|
|
25
32
|
},
|
|
26
33
|
"dependencies": {
|
|
27
|
-
"@abitechdev/openchasqui-spec": "^0.1.
|
|
34
|
+
"@abitechdev/openchasqui-spec": "^0.1.1"
|
|
28
35
|
}
|
|
29
36
|
}
|