@unispechq/unispec-schema 0.1.5 → 0.2.0
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 +7 -10
- package/index.d.ts +9 -0
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ It contains everything required to understand, validate, and evolve the language
|
|
|
13
13
|
- Human-readable reference documentation
|
|
14
14
|
- Official examples (REST, GraphQL, WebSocket, mixed APIs)
|
|
15
15
|
- Versioning and compatibility rules
|
|
16
|
-
-
|
|
16
|
+
- Documented process for evolving the format over time
|
|
17
17
|
|
|
18
18
|
UniSpec powers all components of the UniSpec platform:
|
|
19
19
|
Core Engine → CLI → Framework Adapters → Registry → Portal → Enterprise extensions.
|
|
@@ -57,7 +57,7 @@ This repo defines the UniSpec language, not its implementation.
|
|
|
57
57
|
- JSON Schemas
|
|
58
58
|
- Examples and documentation
|
|
59
59
|
- Rules for versioning and compatibility
|
|
60
|
-
-
|
|
60
|
+
- Documented process for evolving the format over time
|
|
61
61
|
|
|
62
62
|
### This repository does NOT contain:
|
|
63
63
|
|
|
@@ -91,7 +91,7 @@ UniSpec is built on the following principles:
|
|
|
91
91
|
- Supports custom extensions via x-extensions, similar to OpenAPI but cleaner and more consistent.
|
|
92
92
|
|
|
93
93
|
5. Transparent evolution
|
|
94
|
-
- All major changes
|
|
94
|
+
- All major changes must be clearly documented.
|
|
95
95
|
- Minor changes and clarifications must maintain backward compatibility.
|
|
96
96
|
|
|
97
97
|
## JSON Schema
|
|
@@ -104,7 +104,7 @@ The canonical, machine-readable definition of UniSpec lives in the schema/ direc
|
|
|
104
104
|
- Must use $defs for reusable components
|
|
105
105
|
- Must clearly describe field semantics and constraints
|
|
106
106
|
- All examples must validate against the schema
|
|
107
|
-
- Breaking changes require
|
|
107
|
+
- Breaking changes require explicit agreement and a major version bump
|
|
108
108
|
|
|
109
109
|
## Examples
|
|
110
110
|
|
|
@@ -138,7 +138,7 @@ UniSpec follows Semantic Versioning (SemVer):
|
|
|
138
138
|
|
|
139
139
|
All changes must be recorded in CHANGELOG.md.
|
|
140
140
|
|
|
141
|
-
##
|
|
141
|
+
## Format Changes and Contributions
|
|
142
142
|
|
|
143
143
|
Any change that alters:
|
|
144
144
|
|
|
@@ -147,10 +147,7 @@ Any change that alters:
|
|
|
147
147
|
- compatibility rules
|
|
148
148
|
- supported protocols
|
|
149
149
|
|
|
150
|
-
|
|
151
|
-
unispec-rfcs repository before being applied here.
|
|
152
|
-
|
|
153
|
-
No schema modifications may occur without a corresponding approved RFC.
|
|
150
|
+
should be proposed and discussed in a pull request before being applied here.
|
|
154
151
|
|
|
155
152
|
## Contributing
|
|
156
153
|
|
|
@@ -159,7 +156,7 @@ Contributions are welcome!
|
|
|
159
156
|
To contribute:
|
|
160
157
|
|
|
161
158
|
1. Read the reference docs.
|
|
162
|
-
2.
|
|
159
|
+
2. Discuss substantial format changes in an issue or pull request.
|
|
163
160
|
3. Submit a PR with clear explanation and schema validation.
|
|
164
161
|
|
|
165
162
|
All contributions must preserve backward compatibility unless explicitly approved otherwise.
|
package/index.d.ts
ADDED
package/package.json
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@unispechq/unispec-schema",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Official UniSpec JSON Schemas",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.cjs",
|
|
7
7
|
"module": "index.mjs",
|
|
8
|
+
"types": "index.d.ts",
|
|
8
9
|
"scripts": {
|
|
9
10
|
"release:patch": "node scripts/release.js patch",
|
|
10
11
|
"release:minor": "node scripts/release.js minor",
|
|
@@ -13,7 +14,8 @@
|
|
|
13
14
|
"exports": {
|
|
14
15
|
".": {
|
|
15
16
|
"import": "./index.mjs",
|
|
16
|
-
"require": "./index.cjs"
|
|
17
|
+
"require": "./index.cjs",
|
|
18
|
+
"types": "./index.d.ts"
|
|
17
19
|
},
|
|
18
20
|
"./schema": "./schema/index.json",
|
|
19
21
|
"./schema/unispec.schema.json": "./schema/unispec.schema.json"
|
|
@@ -21,7 +23,8 @@
|
|
|
21
23
|
"files": [
|
|
22
24
|
"schema/",
|
|
23
25
|
"index.cjs",
|
|
24
|
-
"index.mjs"
|
|
26
|
+
"index.mjs",
|
|
27
|
+
"index.d.ts"
|
|
25
28
|
],
|
|
26
29
|
"license": "MIT",
|
|
27
30
|
"repository": {
|