@@ -106,11 +106,11 @@ Not just a command line tool, speccy can be used to normalize machine-readable s
106
106
The loader object will return a promise that resolves to an object containing
107
107
the specification. For example:
108
108
109
- ``` javascript
109
+ ``` javascript
110
110
const loader = require (' speccy/lib/loader' );
111
111
112
112
const options = {
113
- resolve: true , // Resolve external references
113
+ resolve: true , // Resolve external references
114
114
jsonSchema: true // Treat $ref like JSON Schema and convert to OpenAPI Schema Objects
115
115
};
116
116
@@ -120,24 +120,6 @@ loader
120
120
` ` `
121
121
122
122
If ` options .resolve ` is truthy, speccy will resolve _external_ references.
123
- However, the loaded specification it may contain JSON pointers in lieu of
124
- _internal_ javascript references. A library like reftools can convert those
125
- pointers back to references:
126
-
127
- ` ` ` javascript
128
- const loader = require (' speccy/lib/loader' );
129
- const { dereference } = require (' reftools/lib/dereference' );
130
-
131
- const options = {
132
- resolve: true , // Resolve external references
133
- jsonSchema: true // Treat $ref like JSON Schema and convert to OpenAPI Schema Objects
134
- };
135
-
136
- module .exports = () => loader
137
- .loadSpec (' path/to/my/spec' , options) // Load the spec...
138
- .then (spec => Promise .resolve (dereference (spec))) // Resolve internal references.
139
- .then (spec => console .log (JSON .stringify (spec)); // ...and print it out.
140
- ` ` `
141
123
142
124
## Tests
143
125
0 commit comments