Skip to content

Commit 7def50e

Browse files
schoeroschoero
committed
chore: update schema
1 parent 7b52491 commit 7def50e

File tree

1 file changed

+76
-68
lines changed

1 file changed

+76
-68
lines changed

‎schemas/renderer/config.json

+76-68
Original file line numberDiff line numberDiff line change
@@ -115,12 +115,12 @@
115115
},
116116
"inlineTitleEncapsulation": {
117117
"anyOf": [
118-
{
119-
"$ref": "#/definitions/Encapsulation"
120-
},
121118
{
122119
"const": false,
123120
"type": "boolean"
121+
},
122+
{
123+
"$ref": "#/definitions/Encapsulation"
124124
}
125125
],
126126
"description": "Defines how inline titles should be encapsulated in the rendered output."
@@ -136,40 +136,40 @@
136136
},
137137
"parameterEncapsulation": {
138138
"anyOf": [
139-
{
140-
"$ref": "#/definitions/Encapsulation"
141-
},
142139
{
143140
"const": false,
144141
"type": "boolean"
142+
},
143+
{
144+
"$ref": "#/definitions/Encapsulation"
145145
}
146146
],
147147
"description": "Defines how parameters should be encapsulated in the rendered output."
148148
},
149149
"propertyEncapsulation": {
150150
"anyOf": [
151-
{
152-
"$ref": "#/definitions/Encapsulation"
153-
},
154151
{
155152
"const": false,
156153
"type": "boolean"
154+
},
155+
{
156+
"$ref": "#/definitions/Encapsulation"
157157
}
158158
],
159159
"description": "Defines how properties should be encapsulated in the rendered output."
160160
},
161161
"renderClassMemberTitles": {
162162
"anyOf": [
163-
{
164-
"type": "boolean"
165-
},
166163
{
167164
"const": "documentation",
168165
"type": "string"
169166
},
170167
{
171168
"const": "tableOfContents",
172169
"type": "string"
170+
},
171+
{
172+
"type": "boolean"
173173
}
174174
],
175175
"description": "Defines whether the renderer should render titles for object members."
@@ -180,20 +180,24 @@
180180
},
181181
"renderEntityPrefixes": {
182182
"anyOf": [
183-
{
184-
"type": "boolean"
185-
},
186183
{
187184
"const": "documentation",
188185
"type": "string"
189186
},
190187
{
191188
"const": "tableOfContents",
192189
"type": "string"
190+
},
191+
{
192+
"type": "boolean"
193193
}
194194
],
195195
"description": "Defines whether the renderer should render prefixes for entities."
196196
},
197+
"renderInternalEntities": {
198+
"description": "Defines whether entities marked with an `@internal` tag should appear in the rendered output.",
199+
"type": "boolean"
200+
},
197201
"renderOrder": {
198202
"description": "Defines the order in which entities should be rendered.",
199203
"items": {
@@ -203,16 +207,16 @@
203207
},
204208
"renderParentNames": {
205209
"anyOf": [
206-
{
207-
"type": "boolean"
208-
},
209210
{
210211
"const": "documentation",
211212
"type": "string"
212213
},
213214
{
214215
"const": "tableOfContents",
215216
"type": "string"
217+
},
218+
{
219+
"type": "boolean"
216220
}
217221
],
218222
"description": "Defines whether the parent name of members should be rendered in the signature."
@@ -235,24 +239,24 @@
235239
},
236240
"stringLiteralEncapsulation": {
237241
"anyOf": [
238-
{
239-
"$ref": "#/definitions/Encapsulation"
240-
},
241242
{
242243
"const": false,
243244
"type": "boolean"
245+
},
246+
{
247+
"$ref": "#/definitions/Encapsulation"
244248
}
245249
],
246250
"description": "Defines how string literal type annotations should be encapsulated in the rendered output."
247251
},
248252
"tagEncapsulation": {
249253
"anyOf": [
250-
{
251-
"$ref": "#/definitions/Encapsulation"
252-
},
253254
{
254255
"const": false,
255256
"type": "boolean"
257+
},
258+
{
259+
"$ref": "#/definitions/Encapsulation"
256260
}
257261
],
258262
"description": "Defines how tags like `@beta` or `@deprecated` should be encapsulated in the rendered output."
@@ -492,24 +496,24 @@
492496
},
493497
"typeEncapsulation": {
494498
"anyOf": [
495-
{
496-
"$ref": "#/definitions/Encapsulation"
497-
},
498499
{
499500
"const": false,
500501
"type": "boolean"
502+
},
503+
{
504+
"$ref": "#/definitions/Encapsulation"
501505
}
502506
],
503507
"description": "Defines how type annotations should be encapsulated in the rendered output."
504508
},
505509
"typeParameterEncapsulation": {
506510
"anyOf": [
507-
{
508-
"$ref": "#/definitions/Encapsulation"
509-
},
510511
{
511512
"const": false,
512513
"type": "boolean"
514+
},
515+
{
516+
"$ref": "#/definitions/Encapsulation"
513517
}
514518
],
515519
"description": "Defines how type parameters should be encapsulated in the rendered output."
@@ -531,15 +535,15 @@
531535
{
532536
"additionalProperties": {
533537
"anyOf": [
538+
{
539+
"const": "*",
540+
"type": "string"
541+
},
534542
{
535543
"items": {
536544
"type": "string"
537545
},
538546
"type": "array"
539-
},
540-
{
541-
"const": "*",
542-
"type": "string"
543547
}
544548
]
545549
},
@@ -570,15 +574,15 @@
570574
"properties": {
571575
"allowedHTMLTags": {
572576
"anyOf": [
577+
{
578+
"const": false,
579+
"type": "boolean"
580+
},
573581
{
574582
"items": {
575583
"type": "string"
576584
},
577585
"type": "array"
578-
},
579-
{
580-
"const": false,
581-
"type": "boolean"
582586
}
583587
],
584588
"description": "Defines which HTML tags are allowed in the rendered output. Will be used in the future to render anchor nodes."
@@ -589,12 +593,12 @@
589593
},
590594
"inlineTitleEncapsulation": {
591595
"anyOf": [
592-
{
593-
"$ref": "#/definitions/Encapsulation"
594-
},
595596
{
596597
"const": false,
597598
"type": "boolean"
599+
},
600+
{
601+
"$ref": "#/definitions/Encapsulation"
598602
}
599603
],
600604
"description": "Defines how inline titles should be encapsulated in the rendered output."
@@ -610,40 +614,40 @@
610614
},
611615
"parameterEncapsulation": {
612616
"anyOf": [
613-
{
614-
"$ref": "#/definitions/Encapsulation"
615-
},
616617
{
617618
"const": false,
618619
"type": "boolean"
620+
},
621+
{
622+
"$ref": "#/definitions/Encapsulation"
619623
}
620624
],
621625
"description": "Defines how parameters should be encapsulated in the rendered output."
622626
},
623627
"propertyEncapsulation": {
624628
"anyOf": [
625-
{
626-
"$ref": "#/definitions/Encapsulation"
627-
},
628629
{
629630
"const": false,
630631
"type": "boolean"
632+
},
633+
{
634+
"$ref": "#/definitions/Encapsulation"
631635
}
632636
],
633637
"description": "Defines how properties should be encapsulated in the rendered output."
634638
},
635639
"renderClassMemberTitles": {
636640
"anyOf": [
637-
{
638-
"type": "boolean"
639-
},
640641
{
641642
"const": "documentation",
642643
"type": "string"
643644
},
644645
{
645646
"const": "tableOfContents",
646647
"type": "string"
648+
},
649+
{
650+
"type": "boolean"
647651
}
648652
],
649653
"description": "Defines whether the renderer should render titles for object members."
@@ -654,20 +658,24 @@
654658
},
655659
"renderEntityPrefixes": {
656660
"anyOf": [
657-
{
658-
"type": "boolean"
659-
},
660661
{
661662
"const": "documentation",
662663
"type": "string"
663664
},
664665
{
665666
"const": "tableOfContents",
666667
"type": "string"
668+
},
669+
{
670+
"type": "boolean"
667671
}
668672
],
669673
"description": "Defines whether the renderer should render prefixes for entities."
670674
},
675+
"renderInternalEntities": {
676+
"description": "Defines whether entities marked with an `@internal` tag should appear in the rendered output.",
677+
"type": "boolean"
678+
},
671679
"renderOrder": {
672680
"description": "Defines the order in which entities should be rendered.",
673681
"items": {
@@ -677,16 +685,16 @@
677685
},
678686
"renderParentNames": {
679687
"anyOf": [
680-
{
681-
"type": "boolean"
682-
},
683688
{
684689
"const": "documentation",
685690
"type": "string"
686691
},
687692
{
688693
"const": "tableOfContents",
689694
"type": "string"
695+
},
696+
{
697+
"type": "boolean"
690698
}
691699
],
692700
"description": "Defines whether the parent name of members should be rendered in the signature."
@@ -712,24 +720,24 @@
712720
},
713721
"stringLiteralEncapsulation": {
714722
"anyOf": [
715-
{
716-
"$ref": "#/definitions/Encapsulation"
717-
},
718723
{
719724
"const": false,
720725
"type": "boolean"
726+
},
727+
{
728+
"$ref": "#/definitions/Encapsulation"
721729
}
722730
],
723731
"description": "Defines how string literal type annotations should be encapsulated in the rendered output."
724732
},
725733
"tagEncapsulation": {
726734
"anyOf": [
727-
{
728-
"$ref": "#/definitions/Encapsulation"
729-
},
730735
{
731736
"const": false,
732737
"type": "boolean"
738+
},
739+
{
740+
"$ref": "#/definitions/Encapsulation"
733741
}
734742
],
735743
"description": "Defines how tags like `@beta` or `@deprecated` should be encapsulated in the rendered output."
@@ -969,24 +977,24 @@
969977
},
970978
"typeEncapsulation": {
971979
"anyOf": [
972-
{
973-
"$ref": "#/definitions/Encapsulation"
974-
},
975980
{
976981
"const": false,
977982
"type": "boolean"
983+
},
984+
{
985+
"$ref": "#/definitions/Encapsulation"
978986
}
979987
],
980988
"description": "Defines how type annotations should be encapsulated in the rendered output."
981989
},
982990
"typeParameterEncapsulation": {
983991
"anyOf": [
984-
{
985-
"$ref": "#/definitions/Encapsulation"
986-
},
987992
{
988993
"const": false,
989994
"type": "boolean"
995+
},
996+
{
997+
"$ref": "#/definitions/Encapsulation"
990998
}
991999
],
9921000
"description": "Defines how type parameters should be encapsulated in the rendered output."

0 commit comments

Comments
 (0)