-
Notifications
You must be signed in to change notification settings - Fork 15
/
yang-openapi.coffee
418 lines (399 loc) · 13.1 KB
/
yang-openapi.coffee
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# OPENAPI (swagger) specification feature
debug = require('debug')('yang-swagger') if process.env.DEBUG?
traverse = require 'traverse'
Yang = require 'yang-js'
yaml = require 'js-yaml'
# TODO: this should be handled via separate yang-json-schema module
definitions = {}
yang2jstype = (schema) ->
switch schema.state.basetype
when 'uint8','int8'
type: 'integer'
format: 'byte'
when 'uint16','uint32','uint64','int16','int32','int64'
type: 'integer'
format: schema.state.basetype
when 'binary'
type: 'string'
format: 'binary'
when 'decimal64'
type: 'number'
format: 'double'
when 'union'
anyOf: [].concat(schema.type).map (s) => yang2jstype s, true
type: 'string'
format: schema.tag
when 'boolean'
type: 'boolean'
format: schema.tag
when 'enumeration'
type: 'string'
format: schema.tag
enum: schema.enum.map (e) -> e.tag
else
# TODO: handle pattern?
type: 'string'
format: schema.tag
yang2jsprop = (schema) ->
js =
description: schema.description?.tag
default: schema.default?.tag
return js unless schema.type?
datatype = yang2jstype schema.type
js[k] = v for k, v of datatype
return js
yang2jsobj = (schema) ->
return {} unless schema?
#debug? "[#{schema.uri}] converting schema to JSON-schema"
js =
description: schema.description?.tag
required = []
property = schema.nodes
.filter (x) -> x.kind not in ['action', 'choice'] and x.parent is schema
.map (node) ->
if node.mandatory?.valueOf() is true
required.push node.tag
name: node.tag
schema: yang2jschema node.origin ? node
choices = schema.choice?.filter (x) -> x.parent is schema
.map (choice) -> anyOf: choice.case?.map (node) -> yang2jsobj node.origin ? node
refs = schema.uses?.filter (x) -> x.parent is schema
switch
when refs?.length
refs.forEach (ref) ->
unless definitions[ref.tag]?
debug? "[yang2jsobj] defining #{ref.tag} using #{schema.uri}"
definitions[ref.tag] = true
definitions[ref.tag] = yang2jsobj schema.lookup('grouping', ref.tag)
if refs.length > 1 or property.length
js.allOf = refs.map (ref) -> '$ref': "#/definitions/#{ref.tag}"
if property.length
js.allOf.push
required: if required.length then required else undefined
property: property
if choices?.length
js.allOf.push choices...
else
ref = refs[0]
js['$ref'] = "#/definitions/#{ref.tag}"
when choices?.length
if choices.length > 1 or property.length
js.allOf = [].concat choices
if property.length
js.allOf.push
required: if required.length then required else undefined
property: property
else
js.anyOf = choices[0].anyOf
else
js.type = 'object'
js.property = property if property.length
js.required = required if required.length
return js
yang2jschema = (schema, item=false) ->
return {} unless schema?
switch schema.kind
when 'leaf' then yang2jsprop schema
when 'leaf-list' then type: 'array', items: yang2jsprop schema
when 'list'
unless item then type: 'array', items: yang2jsobj schema
else yang2jsobj schema
when 'grouping' then {}
else yang2jsobj schema
discoverOperations = (schema, item=false) ->
debug? "[discoverOperations] inspecting #{schema.uri}"
origin = schema.root.tag
deprecated = schema.status?.valueOf() is 'deprecated'
switch
when schema.kind in [ 'rpc', 'action' ] then [
method: 'post'
tags: [ origin ]
description: schema.description?.tag
summary: "Invokes #{schema.tag} in #{schema.parent.tag}"
deprecated: deprecated
parameter: [
name: "#{schema.tag}:input"
in: 'body'
description: schema.input?.description?.tag
schema: yang2jschema schema.input
]
response: [
code: 200
description: "Expected response of #{schema.tag}"
schema: yang2jschema schema.output
]
]
when schema.kind is 'list' and not item then [
method: 'post'
tags: [ origin ]
description: schema.description?.tag
summary: "Creates one or more new #{schema.tag} in #{schema.parent.tag}"
deprecated: deprecated
parameter: [
name: "#{schema.tag}"
in: 'body'
description: schema.description?.tag
schema: yang2jschema schema
]
response: [
code: 200
description: "Expected response for creating #{schema.tag}(s) in collection"
schema: yang2jschema schema
]
,
method: 'get'
tags: [ origin ]
summary: "List all #{schema.tag}s from #{schema.parent.tag}"
deprecated: deprecated
response: [
code: 200
description: "Expected response of #{schema.tag}s"
schema: yang2jschema schema
]
,
method: 'put'
tags: [ origin ]
summary: "Replace the entire #{schema.tag} collection"
deprecated: deprecated
parameter: [
name: "#{schema.tag}"
in: 'body'
description: schema.description?.tag
schema: yang2jschema schema
]
response: [
code: 201
description: "Expected response for replacing collection"
]
,
method: 'patch'
tags: [ origin ]
summary: "Merge items into the #{schema.tag} collection"
deprecated: deprecated
parameter: [
name: "#{schema.tag}"
in: 'body'
description: schema.description?.tag
schema: yang2jschema schema
]
response: [
code: 201
description: "Expected response for merging into collection"
]
]
else [
method: 'get'
tags: [ origin ]
description: schema.description?.tag
summary: "View detail on #{schema.tag}"
deprecated: deprecated
response: [
code: 200
description: "Expected response of #{schema.tag}"
schema: yang2jschema schema, item
]
,
method: 'put'
tags: [ origin ]
summary: "Update details on #{schema.tag}"
deprecated: deprecated
parameter: [
name: "#{schema.tag}"
in: 'body'
description: schema.description?.tag
schema: yang2jschema schema, item
]
response: [
code: 200
description: "Expected response of #{schema.tag}"
schema: yang2jschema schema, item
]
,
method: 'patch'
tags: [ origin ]
summary: "Merge details on #{schema.tag}"
deprecated: deprecated
parameter: [
name: "#{schema.tag}"
in: 'body'
description: schema.description?.tag
schema: yang2jschema schema, item
]
response: [
code: 200
description: "Expected response of #{schema.tag}"
schema: yang2jschema schema, item
]
,
method: 'delete'
tags: [ origin ]
summary: "Delete #{schema.tag} from #{schema.parent.tag}"
deprecated: deprecated
response: [
code: 204
description: "Expected response for delete"
]
]
discoverPathParameter = (schema) ->
debug? "[discoverPathParameter] inspecting #{schema.uri}"
switch
when not schema.key?
name: 'index'
in: 'path'
required: true
type: 'integer'
format: 'int64'
description: "An index key identifying #{schema.tag} item (may change over time)"
when schema.key.tag.length > 1
name: "#{schema.key.tag.join('+')}"
in: 'path'
required: true
type: 'string'
format: 'composite'
description: "A composite key uniquely identifying #{schema.tag} item"
else
param =
name: "#{schema.key.valueOf()}"
in: 'path'
required: true
description: "A key uniquely identifying #{schema.tag} item"
param[k] = v for k, v of yang2jsprop schema.locate(param.name) when v?
return param
discoverPaths = (schema) ->
return [] unless schema.kind in [ 'list', 'container', 'rpc', 'action' ]
return [] if schema['if-feature']? # XXX ignore if-feature entries...
name = "/#{schema.datakey}"
debug? "[discoverPaths] inspecting #{schema.uri}"
paths = [
name: name
operation: discoverOperations schema
]
subpaths = [].concat (discoverPaths sub for sub in schema.nodes)...
switch schema.kind
when 'list'
param = discoverPathParameter(schema)
# test if any subpaths have same param.name
for sub in subpaths
if (sub.parameter?.some (x) -> x.name is param.name)
param.name = "#{schema.tag}-#{param.name}"
break
subpaths.forEach (x) ->
x.parameter?.push param
x.parameter ?= [ param ]
x.name = "#{name}/{#{param.name}}" + x.name
debug? "[discoverPaths] subpath #{x.name} has parameters: #{x.parameter.map (p) -> p.name}"
paths.push
name: "#{name}/{#{param.name}}"
parameter: [ param ]
operation: discoverOperations(schema,true)
when 'container'
subpaths.forEach (x) -> x.name = name + x.name
debug? "[discoverPaths] discovered #{paths.length} paths with #{subpaths.length} subpaths inside #{schema.uri}"
paths.concat subpaths...
discoverTags = (schema) ->
return [] unless schema.kind in [ 'list', 'container', 'rpc', 'action' ]
return [] if schema['if-feature']? # XXX ignore if-feature entries...
name = "/#{schema.datakey}"
debug? "[discoverTags] inspecting #{schema.uri}"
tag =
name: name
description: schema.description?.tag ? "Operations related to #{name}"
if schema.reference?.tag
tag.externalDocs =
description: "Find out more about #{name}"
url: schema.reference.tag
return tag
serializeJSchema = (jschema) ->
return unless jschema?
isProperty = ('property' of jschema)
o = {}
o[k] = v for k, v of jschema when k isnt 'property'
o.properties = jschema.property?.reduce ((a, _prop) ->
a[_prop.name] = serializeJSchema _prop.schema
return a
), {}
o.items = serializeJSchema o.items
o.allOf = o.allOf?.map (x) -> serializeJSchema x
# Swagger 2.0 does NOT support anyOf or oneOf
#o.anyOf = o.anyOf?.map (x) -> serializeJSchema x
#o.oneOf = o.oneOf?.map (x) -> serializeJSchema x
switch
when o.anyOf? and isProperty
o.type ?= 'object'
o.properties ?= {}
o.anyOf.forEach (x) ->
x.property?.forEach (prop) ->
o.properties[prop.name] = serializeJSchema prop.schema
delete o.anyOf
when o.anyOf?
o.type ?= 'string'
o.format ?= 'union'
delete o.anyOf
return o
module.exports = require('./yang-openapi.yang').bind {
transform: (ctx, input) ->
debug? "[transform] using '#{input['@choice']}' as source"
switch input['@choice']
when 'swagger-file' then throw ctx.error "swagger-file transform feature not yet supported!"
debug? "[transform] importing '#{input.modules}'"
modules = input.modules
.map (name) => ctx.schema.constructor.import(name)
.filter (x) -> x?
unless modules.length
throw ctx.error "unable to transform without any modules"
found = modules.map (x) -> x.datakey
debug? "[transform] transforming #{found}"
definitions = {} # XXX - usage of globals is a hack (will have concurrency issues)
output =
spec:
swagger: '2.0'
info: ctx.get('/info')
consumes: [ "application/json" ]
produces: [ "application/json" ]
tag: modules
.map (m) ->
tag = name: m.tag, description: "Operations related to #{m.tag}"
if m.reference?.tag
tag.externalDocs =
description: "Find out more about #{m.tag}"
url: m.reference.tag
return tag
path: modules
.map (m) -> discoverPaths(schema) for schema in m.nodes
.reduce ((a,b) -> a.concat b...), []
definition: (name: k, schema: v for k, v of definitions)
return output
'grouping(specification)/serialize': (ctx, input) ->
debug? "[#{ctx.path}] serializing specification"
spec = ctx.toJSON(false)
spec.tags = spec.tag
spec.paths = spec.path.reduce ((a,_path) ->
path = a[_path.name] = '$ref': _path['$ref']
for op in _path.operation ? []
operation = path[op.method] = {}
operation[k] = v for k, v of op when k not in [ 'method', 'parameter', 'response' ]
operation.parameters = traverse(op.parameter).map (x) ->
@update serializeJSchema(x), true if @key is 'schema'
operation.responses = op.response.reduce ((x,_res) ->
x[_res.code] =
description: _res.description
schema: serializeJSchema _res.schema
return x
), {}
path.parameters = _path.parameter
return a
), {}
spec.definitions = spec.definition?.reduce ((a,_def) ->
a[_def.name] = serializeJSchema _def.schema
return a
), {}
delete spec.tag
delete spec.path
delete spec.definition
delete spec.serialize
spec = traverse(spec).map (x) -> @remove() unless x?
return
data: switch input.format
when 'json' then JSON.stringify spec, null, 2
when 'yaml' then yaml.dump spec, lineWidth: -1
}