@scalar/openapi-parser 0.1.0 → 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/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @scalar/openapi-parser
2
2
 
3
+ ## 0.2.0
4
+
5
+ ### Minor Changes
6
+
7
+ - bf4568e: refactor: rewrite the whole package :)
8
+
3
9
  ## 0.1.0
4
10
 
5
11
  ### Minor Changes
package/README.md CHANGED
@@ -19,7 +19,7 @@ npm add @scalar/openapi-parser
19
19
  ### Parse
20
20
 
21
21
  ```ts
22
- import { parse } from '@scalar/openapi-parser'
22
+ import { resolve } from '@scalar/openapi-parser'
23
23
 
24
24
  const file = `{
25
25
  "openapi": "3.1.0",
@@ -30,7 +30,7 @@ const file = `{
30
30
  "paths": {}
31
31
  }`
32
32
 
33
- const result = await parse(file)
33
+ const result = await resolve(file)
34
34
  ```
35
35
 
36
36
  ### Validate
@@ -59,7 +59,7 @@ if (!result.valid) {
59
59
  ### Version
60
60
 
61
61
  ```ts
62
- import { parse } from '@scalar/openapi-parser'
62
+ import { resolve } from '@scalar/openapi-parser'
63
63
 
64
64
  const file = `{
65
65
  "openapi": "3.1.0",
@@ -70,7 +70,7 @@ const file = `{
70
70
  "paths": {}
71
71
  }`
72
72
 
73
- const result = await parse(file)
73
+ const result = await resolve(file)
74
74
 
75
75
  console.log(result.version)
76
76
  ```