Repository navigation
Expand file tree
/
Copy pathAsyncApiComponents.cs
More file actions
745 lines (675 loc) · 26.2 KB
/
Copy pathAsyncApiComponents.cs
File metadata and controls
745 lines (675 loc) · 26.2 KB
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
namespace ByteBard.AsyncAPI.Models
{
using System;
using System.Collections.Generic;
using System.Linq;
using ByteBard.AsyncAPI.Models.Interfaces;
using ByteBard.AsyncAPI.Writers;
/// <summary>
/// Holds a set of reusable objects for different aspects of the AsyncAPI specification.
/// </summary>
/// <remarks>
/// All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
/// </remarks>
public class AsyncApiComponents : IAsyncApiExtensible, IAsyncApiSerializable
{
/// <summary>
/// An object to hold reusable Schema Object.
/// </summary>
/// <remarks>
/// If this is a Schema Object, then the schemaFormat will be assumed to be "application/vnd.aai.asyncapi+json;version=asyncapi" where the version is equal to the AsyncAPI Version String.
/// </remarks>
public IDictionary<string, AsyncApiMultiFormatSchema> Schemas { get; set; } = new Dictionary<string, AsyncApiMultiFormatSchema>();
/// <summary>
/// An object to hold reusable Server Objects.
/// </summary>
public IDictionary<string, AsyncApiServer> Servers { get; set; } = new Dictionary<string, AsyncApiServer>();
/// <summary>
/// An object to hold reusable Channel Item Objects.
/// </summary>
public IDictionary<string, AsyncApiChannel> Channels { get; set; } = new Dictionary<string, AsyncApiChannel>();
/// <summary>
/// An object to hold reusable Operation Objects.
/// </summary>
public IDictionary<string, AsyncApiOperation> Operations { get; set; } = new Dictionary<string, AsyncApiOperation>();
/// <summary>
/// An object to hold reusable Message Objects.
/// </summary>
public IDictionary<string, AsyncApiMessage> Messages { get; set; } = new Dictionary<string, AsyncApiMessage>();
/// <summary>
/// An object to hold reusable Security Scheme Objects.
/// </summary>
public IDictionary<string, AsyncApiSecurityScheme> SecuritySchemes { get; set; } = new Dictionary<string, AsyncApiSecurityScheme>();
/// <summary>
/// An object to hold reusable Server Variable Objects.
/// </summary>
public IDictionary<string, AsyncApiServerVariable> ServerVariables { get; set; } = new Dictionary<string, AsyncApiServerVariable>();
/// <summary>
/// An object to hold reusable Parameter Objects.
/// </summary>
public IDictionary<string, AsyncApiParameter> Parameters { get; set; } = new Dictionary<string, AsyncApiParameter>();
/// <summary>
/// An object to hold reusable Correlation ID Objects.
/// </summary>
public IDictionary<string, AsyncApiCorrelationId> CorrelationIds { get; set; } = new Dictionary<string, AsyncApiCorrelationId>();
/// <summary>
/// An object to hold reusable Operation Reply Objects.
/// </summary>
public IDictionary<string, AsyncApiOperationReply> Replies { get; set; } = new Dictionary<string, AsyncApiOperationReply>();
/// <summary>
/// An object to hold reusable Operation Reply Address Objects.
/// </summary>
public IDictionary<string, AsyncApiOperationReplyAddress> ReplyAddresses { get; set; } = new Dictionary<string, AsyncApiOperationReplyAddress>();
/// <summary>
/// An object to hold reusable External Documentation Objects.
/// </summary>
public IDictionary<string, AsyncApiExternalDocumentation> ExternalDocs { get; set; } = new Dictionary<string, AsyncApiExternalDocumentation>();
/// <summary>
/// An object to hold reusable Tag Objects.
/// </summary>
public IDictionary<string, AsyncApiTag> Tags { get; set; } = new Dictionary<string, AsyncApiTag>();
/// <summary>
/// An object to hold reusable Operation Trait Objects.
/// </summary>
public IDictionary<string, AsyncApiOperationTrait> OperationTraits { get; set; } = new Dictionary<string, AsyncApiOperationTrait>();
/// <summary>
/// An object to hold reusable Message Trait Objects.
/// </summary>
public IDictionary<string, AsyncApiMessageTrait> MessageTraits { get; set; } = new Dictionary<string, AsyncApiMessageTrait>();
/// <summary>
/// An object to hold reusable Server Bindings Objects.
/// </summary>
public IDictionary<string, AsyncApiBindings<IServerBinding>> ServerBindings { get; set; } = new Dictionary<string, AsyncApiBindings<IServerBinding>>();
/// <summary>
/// An object to hold reusable Channel Bindings Objects.
/// </summary>
public IDictionary<string, AsyncApiBindings<IChannelBinding>> ChannelBindings { get; set; } = new Dictionary<string, AsyncApiBindings<IChannelBinding>>();
/// <summary>
/// An object to hold reusable Operation Bindings Objects.
/// </summary>
public IDictionary<string, AsyncApiBindings<IOperationBinding>> OperationBindings { get; set; } = new Dictionary<string, AsyncApiBindings<IOperationBinding>>();
/// <summary>
/// An object to hold reusable Message Bindings Objects.
/// </summary>
public IDictionary<string, AsyncApiBindings<IMessageBinding>> MessageBindings { get; set; } = new Dictionary<string, AsyncApiBindings<IMessageBinding>>();
public IDictionary<string, IAsyncApiExtension> Extensions { get; set; } = new Dictionary<string, IAsyncApiExtension>();
public void SerializeV2(IAsyncApiWriter writer)
{
if (writer is null)
{
throw new ArgumentNullException(nameof(writer));
}
// If references have been inlined we don't need the to render the components section
// however if they have cycles, then we will need a component rendered
if (writer.GetSettings().InlineLocalReferences)
{
var loops = writer.GetSettings().LoopDetector.Loops;
writer.WriteStartObject();
if (loops.TryGetValue(typeof(AsyncApiJsonSchemaReference), out List<object> schemas))
{
var asyncApiSchemas = schemas.Cast<AsyncApiJsonSchemaReference>().Distinct().ToList()
.ToDictionary<AsyncApiJsonSchemaReference, string>(k => k.Reference.FragmentId);
writer.WriteOptionalMap(
AsyncApiConstants.Schemas,
this.Schemas,
(w, key, component) =>
{
component.SerializeV2(w);
});
}
writer.WriteEndObject();
return;
}
writer.WriteStartObject();
// Serialize each referenceable object as full object without reference if the reference in the object points to itself.
// If the reference exists but points to other objects, the object is serialized to just that reference.
// schemas
writer.WriteOptionalMap(
AsyncApiConstants.Schemas,
this.Schemas,
(w, key, component) =>
{
if (component is AsyncApiMultiFormatSchemaReference reference)
{
reference.Schema.SerializeV2(w);
}
else
{
component.Schema.SerializeV2(w);
}
});
// servers
writer.WriteOptionalMap(
AsyncApiConstants.Servers,
this.Servers,
(w, key, component) =>
{
if (component is AsyncApiServerReference reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
// servers
writer.WriteOptionalMap(
AsyncApiConstants.ServerVariables,
this.ServerVariables,
(w, key, component) =>
{
if (component is AsyncApiServerVariableReference reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
// channels
writer.WriteOptionalMap(
AsyncApiConstants.Channels,
this.Channels,
(w, key, component) =>
{
if (component is AsyncApiChannelReference reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
// messages
writer.WriteOptionalMap(
AsyncApiConstants.Messages,
this.Messages,
(w, key, component) =>
{
if (component is AsyncApiMessageReference reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
// securitySchemes
writer.WriteOptionalMap(
AsyncApiConstants.SecuritySchemes,
this.SecuritySchemes,
(w, key, component) =>
{
if (component is AsyncApiSecuritySchemeReference reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
// parameters
writer.WriteOptionalMap(
AsyncApiConstants.Parameters,
this.Parameters,
(w, key, component) =>
{
if (component is AsyncApiParameterReference reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
// correlationIds
writer.WriteOptionalMap(
AsyncApiConstants.CorrelationIds,
this.CorrelationIds,
(w, key, component) =>
{
if (component is AsyncApiCorrelationIdReference reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
// operationTraits
writer.WriteOptionalMap(
AsyncApiConstants.OperationTraits,
this.OperationTraits,
(w, key, component) =>
{
if (component is AsyncApiOperationTraitReference reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
// messageTraits
writer.WriteOptionalMap(
AsyncApiConstants.MessageTraits,
this.MessageTraits,
(w, key, component) =>
{
if (component is AsyncApiMessageTraitReference reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
//// serverBindings
writer.WriteOptionalMap(
AsyncApiConstants.ServerBindings,
this.ServerBindings,
(w, key, component) =>
{
if (component is AsyncApiBindingsReference<IServerBinding> reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
//// channelBindings
writer.WriteOptionalMap(
AsyncApiConstants.ChannelBindings,
this.ChannelBindings,
(w, key, component) =>
{
if (component is AsyncApiBindingsReference<IChannelBinding> reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
//// operationBindings
writer.WriteOptionalMap(
AsyncApiConstants.OperationBindings,
this.OperationBindings,
(w, key, component) =>
{
if (component is AsyncApiBindingsReference<IOperationBinding> reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
//// messageBindings
writer.WriteOptionalMap(
AsyncApiConstants.MessageBindings,
this.MessageBindings,
(w, key, component) =>
{
if (component is AsyncApiBindingsReference<IMessageBinding> reference)
{
reference.SerializeV2(w);
}
else
{
component.SerializeV2(w);
}
});
// extensions
writer.WriteExtensions(this.Extensions);
writer.WriteEndObject();
}
public void SerializeV3(IAsyncApiWriter writer)
{
if (writer is null)
{
throw new ArgumentNullException(nameof(writer));
}
// If references have been inlined we don't need the to render the components section
// however if they have cycles, then we will need a component rendered
if (writer.GetSettings().InlineLocalReferences)
{
var loops = writer.GetSettings().LoopDetector.Loops;
writer.WriteStartObject();
if (loops.TryGetValue(typeof(AsyncApiMultiFormatSchemaReference), out List<object> schemas))
{
var asyncApiSchemas = schemas.Cast<AsyncApiMultiFormatSchemaReference>().Distinct().ToList()
.ToDictionary<AsyncApiMultiFormatSchemaReference, string>(k => k.Reference.FragmentId);
writer.WriteOptionalMap(
AsyncApiConstants.Schemas,
this.Schemas,
(w, key, component) =>
{
component.SerializeV3(w);
});
}
writer.WriteEndObject();
return;
}
writer.WriteStartObject();
// Serialize each referenceable object as full object without reference if the reference in the object points to itself.
// If the reference exists but points to other objects, the object is serialized to just that reference.
// schemas
writer.WriteOptionalMap(
AsyncApiConstants.Schemas,
this.Schemas,
(w, key, component) =>
{
if (component is AsyncApiMultiFormatSchemaReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// servers
writer.WriteOptionalMap(
AsyncApiConstants.Servers,
this.Servers,
(w, key, component) =>
{
if (component is AsyncApiServerReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// servers
writer.WriteOptionalMap(
AsyncApiConstants.ServerVariables,
this.ServerVariables,
(w, key, component) =>
{
if (component is AsyncApiServerVariableReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// channels
writer.WriteOptionalMap(
AsyncApiConstants.Channels,
this.Channels,
(w, key, component) =>
{
if (component is AsyncApiChannelReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// operations
writer.WriteOptionalMap(
AsyncApiConstants.Operations,
this.Operations,
(w, key, component) =>
{
if (component is AsyncApiOperationReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// messages
writer.WriteOptionalMap(
AsyncApiConstants.Messages,
this.Messages,
(w, key, component) =>
{
if (component is AsyncApiMessageReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// securitySchemes
writer.WriteOptionalMap(
AsyncApiConstants.SecuritySchemes,
this.SecuritySchemes,
(w, key, component) =>
{
if (component is AsyncApiSecuritySchemeReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// server variables
writer.WriteOptionalMap(
AsyncApiConstants.ServerVariables,
this.ServerVariables,
(w, key, component) =>
{
if (component is AsyncApiServerVariableReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// parameters
writer.WriteOptionalMap(
AsyncApiConstants.Parameters,
this.Parameters,
(w, key, component) =>
{
if (component is AsyncApiParameterReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// correlationIds
writer.WriteOptionalMap(
AsyncApiConstants.CorrelationIds,
this.CorrelationIds,
(w, key, component) =>
{
if (component is AsyncApiCorrelationIdReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// replies
writer.WriteOptionalMap(
AsyncApiConstants.Reply,
this.Replies,
(w, key, component) =>
{
if (component is AsyncApiOperationReplyReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// replies
writer.WriteOptionalMap(
AsyncApiConstants.Address,
this.ReplyAddresses,
(w, key, component) =>
{
if (component is AsyncApiOperationReplyAddressReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// external docs
writer.WriteOptionalMap(
AsyncApiConstants.ExternalDocs,
this.ExternalDocs,
(w, key, component) =>
{
if (component is AsyncApiExternalDocumentationReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// tags
writer.WriteOptionalMap(
AsyncApiConstants.Tags,
this.Tags,
(w, key, component) =>
{
if (component is AsyncApiTagReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// operationTraits
writer.WriteOptionalMap(
AsyncApiConstants.OperationTraits,
this.OperationTraits,
(w, key, component) =>
{
if (component is AsyncApiOperationTraitReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// messageTraits
writer.WriteOptionalMap(
AsyncApiConstants.MessageTraits,
this.MessageTraits,
(w, key, component) =>
{
if (component is AsyncApiMessageTraitReference reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
//// serverBindings
writer.WriteOptionalMap(
AsyncApiConstants.ServerBindings,
this.ServerBindings,
(w, key, component) =>
{
if (component is AsyncApiBindingsReference<IServerBinding> reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
//// channelBindings
writer.WriteOptionalMap(
AsyncApiConstants.ChannelBindings,
this.ChannelBindings,
(w, key, component) =>
{
if (component is AsyncApiBindingsReference<IChannelBinding> reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
//// operationBindings
writer.WriteOptionalMap(
AsyncApiConstants.OperationBindings,
this.OperationBindings,
(w, key, component) =>
{
if (component is AsyncApiBindingsReference<IOperationBinding> reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
//// messageBindings
writer.WriteOptionalMap(
AsyncApiConstants.MessageBindings,
this.MessageBindings,
(w, key, component) =>
{
if (component is AsyncApiBindingsReference<IMessageBinding> reference)
{
reference.SerializeV3(w);
}
else
{
component.SerializeV3(w);
}
});
// extensions
writer.WriteExtensions(this.Extensions);
writer.WriteEndObject();
}
}
}