@thymian/rules-api-description-validation 0.1.1 → 0.1.2-canary.20260408-c479a4a
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 +53 -5
- package/package.json +11 -2
package/README.md
CHANGED
|
@@ -1,11 +1,59 @@
|
|
|
1
|
+
<!-- HEADER:START - Do not remove or modify this section -->
|
|
2
|
+
<div align="center">
|
|
3
|
+
<img src="https://raw.githubusercontent.com/thymianofficial/thymian/main/astro-docs/src/assets/logo.svg" alt="Thymian Logo" width="200"/>
|
|
4
|
+
|
|
1
5
|
# Thymian
|
|
2
6
|
|
|
3
|
-
Add resilience and HTTP conformance to your API development workflow
|
|
7
|
+
**Add resilience and HTTP conformance to your API development workflow**
|
|
8
|
+
|
|
9
|
+
[](https://github.com/thymianofficial/thymian/blob/main/LICENSE)
|
|
10
|
+
[](https://github.com/thymianofficial/thymian/actions/workflows/ci.yaml)
|
|
11
|
+
[](https://thymian.dev)
|
|
12
|
+
[](https://discord.gg/TRSwCxbz9f)
|
|
13
|
+
[](https://www.reddit.com/r/ThymianOfficial/)
|
|
14
|
+
[](https://x.com/thymiandev)
|
|
15
|
+
|
|
16
|
+
</div>
|
|
17
|
+
<!-- HEADER:END -->
|
|
18
|
+
|
|
19
|
+
## @thymian/rules-api-description-validation
|
|
20
|
+
|
|
21
|
+
A rule set that validates the structural correctness and best practices of API description documents (e.g. OpenAPI). Checks for well-formed schemas, valid references, consistent naming conventions, and API design guidelines that go beyond syntax validation.
|
|
22
|
+
|
|
23
|
+
## Installation
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm install @thymian/rules-api-description-validation
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
> **Getting started with Thymian?** See the [main Thymian package](https://www.npmjs.com/package/thymian) for quick installation and first-run instructions.
|
|
30
|
+
|
|
31
|
+
<!-- FOOTER:START - Do not remove or modify this section -->
|
|
32
|
+
|
|
33
|
+
## 📚 Documentation
|
|
34
|
+
|
|
35
|
+
- **[Getting Started](https://thymian.dev/introduction/getting-started)** - Set up Thymian in minutes
|
|
36
|
+
- **[Documentation](https://thymian.dev)** - Comprehensive guides and API reference
|
|
37
|
+
- **[CLI Reference](https://thymian.dev/references/cli)** - Complete CLI command documentation
|
|
38
|
+
- **[HTTP Rules](https://thymian.dev/guides/http-rules/how-to-use-rules)** - Learn about HTTP conformance validation
|
|
39
|
+
|
|
40
|
+
## 🏢 Enterprise Support
|
|
41
|
+
|
|
42
|
+
Get professional consulting and dedicated support from the creators of Thymian. We offer:
|
|
43
|
+
|
|
44
|
+
- API design and governance strategies
|
|
45
|
+
- HTTP standards compliance auditing
|
|
46
|
+
- Custom plugin development
|
|
47
|
+
- Custom rule development
|
|
48
|
+
- Team training and workshops
|
|
49
|
+
|
|
50
|
+
**[Learn more about Enterprise Support](https://thymian.dev/enterprise)** | **Email: [support@thymian.dev](mailto:support@thymian.dev)**
|
|
4
51
|
|
|
5
|
-
|
|
52
|
+
---
|
|
6
53
|
|
|
7
|
-
|
|
54
|
+
<div align="center">
|
|
8
55
|
|
|
9
|
-
|
|
56
|
+
**Shipped with 🌱 by [qupaya](https://qupaya.com)**
|
|
10
57
|
|
|
11
|
-
|
|
58
|
+
</div>
|
|
59
|
+
<!-- FOOTER:END -->
|
package/package.json
CHANGED
|
@@ -1,7 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@thymian/rules-api-description-validation",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2-canary.20260408-c479a4a",
|
|
4
4
|
"license": "AGPL-3.0-only",
|
|
5
|
+
"bugs": {
|
|
6
|
+
"url": "https://github.com/thymianofficial/thymian/issues"
|
|
7
|
+
},
|
|
8
|
+
"homepage": "https://thymian.dev",
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "https://github.com/thymianofficial/thymian.git",
|
|
12
|
+
"directory": "packages/rules-api-description-validation"
|
|
13
|
+
},
|
|
5
14
|
"publishConfig": {
|
|
6
15
|
"access": "public"
|
|
7
16
|
},
|
|
@@ -22,6 +31,6 @@
|
|
|
22
31
|
"!**/*.tsbuildinfo"
|
|
23
32
|
],
|
|
24
33
|
"dependencies": {
|
|
25
|
-
"@thymian/core": "0.1.
|
|
34
|
+
"@thymian/core": "0.1.2-canary.20260408-c479a4a"
|
|
26
35
|
}
|
|
27
36
|
}
|