@cparra/apexdocs 2.13.0 → 2.13.1

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.
Files changed (3) hide show
  1. package/docs/restapi.json +589 -589
  2. package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls +35 -35
  3. package/package.json +2 -2
package/docs/restapi.json CHANGED
@@ -1,589 +1,589 @@
1
- {
2
- "openapi": "3.1.0",
3
- "info": {
4
- "title": "Sample REST Api",
5
- "version": "1.0.0"
6
- },
7
- "servers": [
8
- {
9
- "url": "/services/apexrest/nspc/"
10
- }
11
- ],
12
- "paths": {
13
- "AccountService/": {
14
- "description": "Account related operations",
15
- "get": {
16
- "tags": [
17
- "Account Service"
18
- ],
19
- "description": "This is a sample HTTP Get method",
20
- "parameters": [
21
- {
22
- "name": "limit",
23
- "in": "query",
24
- "required": true,
25
- "description": "Limits the number of items on a page",
26
- "schema": {
27
- "type": "integer"
28
- }
29
- },
30
- {
31
- "name": "complex",
32
- "in": "cookie",
33
- "description": "A more complex schema",
34
- "schema": {
35
- "type": "array",
36
- "items": {
37
- "type": "object",
38
- "properties": {
39
- "name": {
40
- "type": "string"
41
- }
42
- }
43
- }
44
- }
45
- }
46
- ],
47
- "responses": {
48
- "100": {
49
- "description": "Status code 100",
50
- "content": {
51
- "application/json": {
52
- "schema": {
53
- "type": "object",
54
- "properties": {
55
- "anotherObject": {
56
- "description": "An object inside of an object",
57
- "type": "object",
58
- "properties": {
59
- "message": {
60
- "type": "string"
61
- },
62
- "somethingElse": {
63
- "type": "number"
64
- }
65
- }
66
- }
67
- }
68
- }
69
- }
70
- }
71
- },
72
- "200": {
73
- "description": "Status code 200",
74
- "content": {
75
- "application/json": {
76
- "schema": {
77
- "type": "object",
78
- "properties": {
79
- "id": {
80
- "type": "string",
81
- "description": "The super Id."
82
- },
83
- "name": {
84
- "type": "string"
85
- },
86
- "phone": {
87
- "type": "string",
88
- "format": "byte"
89
- }
90
- }
91
- }
92
- }
93
- }
94
- },
95
- "304": {
96
- "description": "Status code 304",
97
- "content": {
98
- "application/json": {
99
- "schema": {
100
- "type": "object",
101
- "properties": {
102
- "error": {
103
- "type": "string"
104
- }
105
- }
106
- }
107
- }
108
- }
109
- },
110
- "400": {
111
- "description": "Status code 400",
112
- "content": {
113
- "application/json": {
114
- "schema": {
115
- "type": "array",
116
- "items": {
117
- "type": "object",
118
- "properties": {
119
- "name": {
120
- "type": "string"
121
- }
122
- }
123
- }
124
- }
125
- }
126
- }
127
- },
128
- "500": {
129
- "description": "Status code 500",
130
- "content": {
131
- "application/json": {
132
- "schema": {
133
- "type": "string"
134
- }
135
- }
136
- }
137
- }
138
- }
139
- },
140
- "post": {
141
- "tags": [
142
- "Account Service"
143
- ],
144
- "description": "This is a sample HTTP Post method",
145
- "summary": "Posts an Account 2",
146
- "requestBody": {
147
- "description": "This is an example of a request body",
148
- "content": {
149
- "application/json": {
150
- "schema": {
151
- "type": "array",
152
- "items": {
153
- "type": "object",
154
- "properties": {
155
- "name": {
156
- "type": "string"
157
- }
158
- }
159
- }
160
- }
161
- }
162
- },
163
- "required": true
164
- },
165
- "parameters": [
166
- {
167
- "name": "limit",
168
- "in": "query",
169
- "required": true,
170
- "description": "Limits the number of items on a page",
171
- "schema": {
172
- "type": "integer"
173
- }
174
- },
175
- {
176
- "name": "complex",
177
- "in": "cookie",
178
- "description": "A more complex schema",
179
- "schema": {
180
- "type": "array",
181
- "items": {
182
- "type": "object",
183
- "properties": {
184
- "name": {
185
- "type": "string"
186
- }
187
- }
188
- }
189
- }
190
- }
191
- ],
192
- "responses": {
193
- "200": {
194
- "description": "Status code 200",
195
- "content": {
196
- "application/json": {
197
- "schema": {
198
- "type": "object",
199
- "properties": {
200
- "id": {
201
- "type": "string",
202
- "description": "The super Id."
203
- },
204
- "name": {
205
- "type": "string"
206
- },
207
- "phone": {
208
- "type": "string",
209
- "format": "byte"
210
- }
211
- }
212
- }
213
- }
214
- }
215
- },
216
- "304": {
217
- "description": "Status code 304",
218
- "content": {
219
- "application/json": {
220
- "schema": {
221
- "type": "object",
222
- "properties": {
223
- "error": {
224
- "type": "string"
225
- }
226
- }
227
- }
228
- }
229
- }
230
- },
231
- "400": {
232
- "description": "Status code 400",
233
- "content": {
234
- "application/json": {
235
- "schema": {
236
- "type": "array",
237
- "items": {
238
- "type": "object",
239
- "properties": {
240
- "name": {
241
- "type": "string"
242
- }
243
- }
244
- }
245
- }
246
- }
247
- }
248
- },
249
- "500": {
250
- "description": "Status code 500",
251
- "content": {
252
- "application/json": {
253
- "schema": {
254
- "type": "string"
255
- }
256
- }
257
- }
258
- }
259
- }
260
- },
261
- "delete": {
262
- "tags": [
263
- "Account Service"
264
- ],
265
- "description": "Sample HTTP Delete method with references to other types.",
266
- "parameters": [
267
- {
268
- "name": "limit",
269
- "in": "header",
270
- "required": true,
271
- "description": "My sample description.",
272
- "schema": {
273
- "$ref": "#/components/schemas/SampleClass"
274
- }
275
- }
276
- ],
277
- "responses": {
278
- "200": {
279
- "description": "Status code 200",
280
- "content": {
281
- "application/json": {
282
- "schema": {
283
- "$ref": "#/components/schemas/SampleClass"
284
- }
285
- }
286
- }
287
- },
288
- "304": {
289
- "description": "Status code 304",
290
- "content": {
291
- "application/json": {
292
- "schema": {
293
- "$ref": "#/components/schemas/ChildClass"
294
- }
295
- }
296
- }
297
- },
298
- "305": {
299
- "description": "Status code 305",
300
- "content": {
301
- "application/json": {
302
- "schema": {
303
- "$ref": "#/components/schemas/Reference1"
304
- }
305
- }
306
- }
307
- },
308
- "306": {
309
- "description": "Status code 306",
310
- "content": {
311
- "application/json": {
312
- "schema": {
313
- "$ref": "#/components/schemas/Reference1_array"
314
- }
315
- }
316
- }
317
- },
318
- "307": {
319
- "description": "Status code 307",
320
- "content": {
321
- "application/json": {
322
- "schema": {
323
- "$ref": "#/components/schemas/Reference7_Reference7[untypedObject:Reference2]"
324
- }
325
- }
326
- }
327
- },
328
- "500": {
329
- "description": "Status code 500",
330
- "content": {
331
- "application/json": {
332
- "schema": {
333
- "$ref": "#/components/schemas/SampleClass"
334
- }
335
- }
336
- }
337
- }
338
- }
339
- }
340
- },
341
- "Contact/": {
342
- "description": "Contact related operations",
343
- "get": {
344
- "tags": [
345
- "Contact"
346
- ],
347
- "description": "This is a sample HTTP Get method",
348
- "responses": {
349
- "200": {
350
- "description": "Status code 200",
351
- "content": {
352
- "application/json": {
353
- "schema": {
354
- "$ref": "#/components/schemas/SampleRestResourceWithInnerClass.InnerClass"
355
- }
356
- }
357
- }
358
- }
359
- }
360
- }
361
- },
362
- "Order/": {
363
- "description": "Order related operations",
364
- "get": {
365
- "tags": [
366
- "Order"
367
- ],
368
- "requestBody": {
369
- "content": {
370
- "application/json": {
371
- "schema": {
372
- "type": "object",
373
- "properties": {
374
- "param1": {
375
- "type": "string"
376
- },
377
- "param2": {
378
- "$ref": "#/components/schemas/Reference1"
379
- }
380
- }
381
- }
382
- }
383
- }
384
- },
385
- "responses": {
386
- "200": {
387
- "description": "Status code 200",
388
- "content": {
389
- "application/json": {
390
- "schema": {
391
- "type": "string"
392
- }
393
- }
394
- }
395
- }
396
- }
397
- },
398
- "patch": {
399
- "tags": [
400
- "Order"
401
- ],
402
- "requestBody": {
403
- "content": {
404
- "application/json": {
405
- "schema": {
406
- "type": "object",
407
- "properties": {
408
- "param1": {
409
- "type": "string"
410
- },
411
- "param2": {
412
- "$ref": "#/components/schemas/Reference1"
413
- }
414
- }
415
- }
416
- }
417
- }
418
- },
419
- "responses": {
420
- "200": {
421
- "description": "Status code 200",
422
- "content": {
423
- "application/json": {
424
- "schema": {
425
- "type": "string"
426
- }
427
- }
428
- }
429
- }
430
- }
431
- }
432
- }
433
- },
434
- "tags": [
435
- {
436
- "name": "Account Service",
437
- "description": "Account related operations"
438
- },
439
- {
440
- "name": "Contact",
441
- "description": "Contact related operations"
442
- },
443
- {
444
- "name": "Order",
445
- "description": "Order related operations"
446
- }
447
- ],
448
- "components": {
449
- "schemas": {
450
- "SampleClass": {
451
- "type": "object",
452
- "properties": {
453
- "MyProp": {
454
- "type": "string",
455
- "description": "This is a String property."
456
- },
457
- "AnotherProp": {
458
- "type": "number",
459
- "description": "This is a Decimal property."
460
- },
461
- "listOfStrings": {
462
- "type": "array",
463
- "items": {
464
- "type": "string"
465
- }
466
- },
467
- "someVariable": {
468
- "type": "string"
469
- }
470
- }
471
- },
472
- "ChildClass": {
473
- "type": "object",
474
- "properties": {
475
- "AProp": {
476
- "type": "string"
477
- },
478
- "privateStringFromChild": {
479
- "type": "string"
480
- },
481
- "protectedStringFromParent": {
482
- "type": "string",
483
- "description": "This is a protected string, use carefully."
484
- },
485
- "publicStringFromParent": {
486
- "type": "string"
487
- },
488
- "protectedGrandParentField": {
489
- "type": "string"
490
- }
491
- }
492
- },
493
- "Reference1": {
494
- "type": "object",
495
- "properties": {
496
- "reference2Member": {
497
- "$ref": "#/components/schemas/Reference2",
498
- "description": "This is a reference 2 member. Lorem."
499
- },
500
- "reference3Member": {
501
- "$ref": "#/components/schemas/Reference3"
502
- },
503
- "reference4Collection": {
504
- "type": "array",
505
- "items": {
506
- "$ref": "#/components/schemas/Reference4"
507
- }
508
- },
509
- "reference5Member": {
510
- "$ref": "#/components/schemas/Reference5"
511
- }
512
- }
513
- },
514
- "Reference2": {
515
- "type": "object",
516
- "properties": {
517
- "stringMember": {
518
- "type": "string"
519
- },
520
- "objectReference": {
521
- "$ref": "#/components/schemas/Reference3_array",
522
- "description": "This is an object reference."
523
- }
524
- }
525
- },
526
- "Reference3_array": {
527
- "type": "array",
528
- "items": {
529
- "$ref": "#/components/schemas/Reference3"
530
- }
531
- },
532
- "Reference3": {
533
- "type": "object",
534
- "properties": {
535
- "someBoolean": {
536
- "type": "boolean"
537
- }
538
- }
539
- },
540
- "Reference4": {
541
- "type": "object",
542
- "properties": {
543
- "someString": {
544
- "type": "string"
545
- }
546
- }
547
- },
548
- "Reference5": {
549
- "type": "object",
550
- "properties": {
551
- "reference6Member": {
552
- "$ref": "#/components/schemas/Reference6"
553
- }
554
- }
555
- },
556
- "Reference6": {
557
- "type": "object",
558
- "properties": {
559
- "grandChildString": {
560
- "type": "string",
561
- "description": "This is the grandchild description."
562
- }
563
- }
564
- },
565
- "Reference1_array": {
566
- "type": "array",
567
- "items": {
568
- "$ref": "#/components/schemas/Reference1"
569
- }
570
- },
571
- "Reference7_Reference7[untypedObject:Reference2]": {
572
- "type": "object",
573
- "properties": {
574
- "untypedObject": {
575
- "$ref": "#/components/schemas/Reference2"
576
- }
577
- }
578
- },
579
- "SampleRestResourceWithInnerClass.InnerClass": {
580
- "type": "object",
581
- "properties": {
582
- "stringMember": {
583
- "type": "string"
584
- }
585
- }
586
- }
587
- }
588
- }
589
- }
1
+ {
2
+ "openapi": "3.1.0",
3
+ "info": {
4
+ "title": "Sample REST Api",
5
+ "version": "1.0.0"
6
+ },
7
+ "servers": [
8
+ {
9
+ "url": "/services/apexrest/nspc/"
10
+ }
11
+ ],
12
+ "paths": {
13
+ "AccountService/": {
14
+ "description": "Account related operations",
15
+ "get": {
16
+ "tags": [
17
+ "Account Service"
18
+ ],
19
+ "description": "This is a sample HTTP Get method",
20
+ "parameters": [
21
+ {
22
+ "name": "limit",
23
+ "in": "query",
24
+ "required": true,
25
+ "description": "Limits the number of items on a page",
26
+ "schema": {
27
+ "type": "integer"
28
+ }
29
+ },
30
+ {
31
+ "name": "complex",
32
+ "in": "cookie",
33
+ "description": "A more complex schema",
34
+ "schema": {
35
+ "type": "array",
36
+ "items": {
37
+ "type": "object",
38
+ "properties": {
39
+ "name": {
40
+ "type": "string"
41
+ }
42
+ }
43
+ }
44
+ }
45
+ }
46
+ ],
47
+ "responses": {
48
+ "100": {
49
+ "description": "Status code 100",
50
+ "content": {
51
+ "application/json": {
52
+ "schema": {
53
+ "type": "object",
54
+ "properties": {
55
+ "anotherObject": {
56
+ "description": "An object inside of an object",
57
+ "type": "object",
58
+ "properties": {
59
+ "message": {
60
+ "type": "string"
61
+ },
62
+ "somethingElse": {
63
+ "type": "number"
64
+ }
65
+ }
66
+ }
67
+ }
68
+ }
69
+ }
70
+ }
71
+ },
72
+ "200": {
73
+ "description": "Status code 200",
74
+ "content": {
75
+ "application/json": {
76
+ "schema": {
77
+ "type": "object",
78
+ "properties": {
79
+ "id": {
80
+ "type": "string",
81
+ "description": "The super Id."
82
+ },
83
+ "name": {
84
+ "type": "string"
85
+ },
86
+ "phone": {
87
+ "type": "string",
88
+ "format": "byte"
89
+ }
90
+ }
91
+ }
92
+ }
93
+ }
94
+ },
95
+ "304": {
96
+ "description": "Status code 304",
97
+ "content": {
98
+ "application/json": {
99
+ "schema": {
100
+ "type": "object",
101
+ "properties": {
102
+ "error": {
103
+ "type": "string"
104
+ }
105
+ }
106
+ }
107
+ }
108
+ }
109
+ },
110
+ "400": {
111
+ "description": "Status code 400",
112
+ "content": {
113
+ "application/json": {
114
+ "schema": {
115
+ "type": "array",
116
+ "items": {
117
+ "type": "object",
118
+ "properties": {
119
+ "name": {
120
+ "type": "string"
121
+ }
122
+ }
123
+ }
124
+ }
125
+ }
126
+ }
127
+ },
128
+ "500": {
129
+ "description": "Status code 500",
130
+ "content": {
131
+ "application/json": {
132
+ "schema": {
133
+ "type": "string"
134
+ }
135
+ }
136
+ }
137
+ }
138
+ }
139
+ },
140
+ "post": {
141
+ "tags": [
142
+ "Account Service"
143
+ ],
144
+ "description": "This is a sample HTTP Post method",
145
+ "summary": "Posts an Account 2",
146
+ "requestBody": {
147
+ "description": "This is an example of a request body",
148
+ "content": {
149
+ "application/json": {
150
+ "schema": {
151
+ "type": "array",
152
+ "items": {
153
+ "type": "object",
154
+ "properties": {
155
+ "name": {
156
+ "type": "string"
157
+ }
158
+ }
159
+ }
160
+ }
161
+ }
162
+ },
163
+ "required": true
164
+ },
165
+ "parameters": [
166
+ {
167
+ "name": "limit",
168
+ "in": "query",
169
+ "required": true,
170
+ "description": "Limits the number of items on a page",
171
+ "schema": {
172
+ "type": "integer"
173
+ }
174
+ },
175
+ {
176
+ "name": "complex",
177
+ "in": "cookie",
178
+ "description": "A more complex schema",
179
+ "schema": {
180
+ "type": "array",
181
+ "items": {
182
+ "type": "object",
183
+ "properties": {
184
+ "name": {
185
+ "type": "string"
186
+ }
187
+ }
188
+ }
189
+ }
190
+ }
191
+ ],
192
+ "responses": {
193
+ "200": {
194
+ "description": "Status code 200",
195
+ "content": {
196
+ "application/json": {
197
+ "schema": {
198
+ "type": "object",
199
+ "properties": {
200
+ "id": {
201
+ "type": "string",
202
+ "description": "The super Id."
203
+ },
204
+ "name": {
205
+ "type": "string"
206
+ },
207
+ "phone": {
208
+ "type": "string",
209
+ "format": "byte"
210
+ }
211
+ }
212
+ }
213
+ }
214
+ }
215
+ },
216
+ "304": {
217
+ "description": "Status code 304",
218
+ "content": {
219
+ "application/json": {
220
+ "schema": {
221
+ "type": "object",
222
+ "properties": {
223
+ "error": {
224
+ "type": "string"
225
+ }
226
+ }
227
+ }
228
+ }
229
+ }
230
+ },
231
+ "400": {
232
+ "description": "Status code 400",
233
+ "content": {
234
+ "application/json": {
235
+ "schema": {
236
+ "type": "array",
237
+ "items": {
238
+ "type": "object",
239
+ "properties": {
240
+ "name": {
241
+ "type": "string"
242
+ }
243
+ }
244
+ }
245
+ }
246
+ }
247
+ }
248
+ },
249
+ "500": {
250
+ "description": "Status code 500",
251
+ "content": {
252
+ "application/json": {
253
+ "schema": {
254
+ "type": "string"
255
+ }
256
+ }
257
+ }
258
+ }
259
+ }
260
+ },
261
+ "delete": {
262
+ "tags": [
263
+ "Account Service"
264
+ ],
265
+ "description": "Sample HTTP Delete method with references to other types.",
266
+ "parameters": [
267
+ {
268
+ "name": "limit",
269
+ "in": "header",
270
+ "required": true,
271
+ "description": "My sample description.",
272
+ "schema": {
273
+ "$ref": "#/components/schemas/SampleClass"
274
+ }
275
+ }
276
+ ],
277
+ "responses": {
278
+ "200": {
279
+ "description": "Status code 200",
280
+ "content": {
281
+ "application/json": {
282
+ "schema": {
283
+ "$ref": "#/components/schemas/SampleClass"
284
+ }
285
+ }
286
+ }
287
+ },
288
+ "304": {
289
+ "description": "Status code 304",
290
+ "content": {
291
+ "application/json": {
292
+ "schema": {
293
+ "$ref": "#/components/schemas/ChildClass"
294
+ }
295
+ }
296
+ }
297
+ },
298
+ "305": {
299
+ "description": "Status code 305",
300
+ "content": {
301
+ "application/json": {
302
+ "schema": {
303
+ "$ref": "#/components/schemas/Reference1"
304
+ }
305
+ }
306
+ }
307
+ },
308
+ "306": {
309
+ "description": "Status code 306",
310
+ "content": {
311
+ "application/json": {
312
+ "schema": {
313
+ "$ref": "#/components/schemas/Reference1_array"
314
+ }
315
+ }
316
+ }
317
+ },
318
+ "307": {
319
+ "description": "Status code 307",
320
+ "content": {
321
+ "application/json": {
322
+ "schema": {
323
+ "$ref": "#/components/schemas/Reference7_Reference7[untypedObject:Reference2]"
324
+ }
325
+ }
326
+ }
327
+ },
328
+ "500": {
329
+ "description": "Status code 500",
330
+ "content": {
331
+ "application/json": {
332
+ "schema": {
333
+ "$ref": "#/components/schemas/SampleClass"
334
+ }
335
+ }
336
+ }
337
+ }
338
+ }
339
+ }
340
+ },
341
+ "Contact/": {
342
+ "description": "Contact related operations",
343
+ "get": {
344
+ "tags": [
345
+ "Contact"
346
+ ],
347
+ "description": "This is a sample HTTP Get method",
348
+ "responses": {
349
+ "200": {
350
+ "description": "Status code 200",
351
+ "content": {
352
+ "application/json": {
353
+ "schema": {
354
+ "$ref": "#/components/schemas/SampleRestResourceWithInnerClass.InnerClass"
355
+ }
356
+ }
357
+ }
358
+ }
359
+ }
360
+ }
361
+ },
362
+ "Order/": {
363
+ "description": "Order related operations",
364
+ "get": {
365
+ "tags": [
366
+ "Order"
367
+ ],
368
+ "requestBody": {
369
+ "content": {
370
+ "application/json": {
371
+ "schema": {
372
+ "type": "object",
373
+ "properties": {
374
+ "param1": {
375
+ "type": "string"
376
+ },
377
+ "param2": {
378
+ "$ref": "#/components/schemas/Reference1"
379
+ }
380
+ }
381
+ }
382
+ }
383
+ }
384
+ },
385
+ "responses": {
386
+ "200": {
387
+ "description": "Status code 200",
388
+ "content": {
389
+ "application/json": {
390
+ "schema": {
391
+ "type": "string"
392
+ }
393
+ }
394
+ }
395
+ }
396
+ }
397
+ },
398
+ "patch": {
399
+ "tags": [
400
+ "Order"
401
+ ],
402
+ "requestBody": {
403
+ "content": {
404
+ "application/json": {
405
+ "schema": {
406
+ "type": "object",
407
+ "properties": {
408
+ "param1": {
409
+ "type": "string"
410
+ },
411
+ "param2": {
412
+ "$ref": "#/components/schemas/Reference1"
413
+ }
414
+ }
415
+ }
416
+ }
417
+ }
418
+ },
419
+ "responses": {
420
+ "200": {
421
+ "description": "Status code 200",
422
+ "content": {
423
+ "application/json": {
424
+ "schema": {
425
+ "type": "string"
426
+ }
427
+ }
428
+ }
429
+ }
430
+ }
431
+ }
432
+ }
433
+ },
434
+ "tags": [
435
+ {
436
+ "name": "Account Service",
437
+ "description": "Account related operations"
438
+ },
439
+ {
440
+ "name": "Contact",
441
+ "description": "Contact related operations"
442
+ },
443
+ {
444
+ "name": "Order",
445
+ "description": "Order related operations"
446
+ }
447
+ ],
448
+ "components": {
449
+ "schemas": {
450
+ "SampleClass": {
451
+ "type": "object",
452
+ "properties": {
453
+ "MyProp": {
454
+ "type": "string",
455
+ "description": "This is a String property."
456
+ },
457
+ "AnotherProp": {
458
+ "type": "number",
459
+ "description": "This is a Decimal property."
460
+ },
461
+ "listOfStrings": {
462
+ "type": "array",
463
+ "items": {
464
+ "type": "string"
465
+ }
466
+ },
467
+ "someVariable": {
468
+ "type": "string"
469
+ }
470
+ }
471
+ },
472
+ "ChildClass": {
473
+ "type": "object",
474
+ "properties": {
475
+ "AProp": {
476
+ "type": "string"
477
+ },
478
+ "privateStringFromChild": {
479
+ "type": "string"
480
+ },
481
+ "protectedStringFromParent": {
482
+ "type": "string",
483
+ "description": "This is a protected string, use carefully."
484
+ },
485
+ "publicStringFromParent": {
486
+ "type": "string"
487
+ },
488
+ "protectedGrandParentField": {
489
+ "type": "string"
490
+ }
491
+ }
492
+ },
493
+ "Reference1": {
494
+ "type": "object",
495
+ "properties": {
496
+ "reference2Member": {
497
+ "$ref": "#/components/schemas/Reference2",
498
+ "description": "This is a reference 2 member. Lorem."
499
+ },
500
+ "reference3Member": {
501
+ "$ref": "#/components/schemas/Reference3"
502
+ },
503
+ "reference4Collection": {
504
+ "type": "array",
505
+ "items": {
506
+ "$ref": "#/components/schemas/Reference4"
507
+ }
508
+ },
509
+ "reference5Member": {
510
+ "$ref": "#/components/schemas/Reference5"
511
+ }
512
+ }
513
+ },
514
+ "Reference2": {
515
+ "type": "object",
516
+ "properties": {
517
+ "stringMember": {
518
+ "type": "string"
519
+ },
520
+ "objectReference": {
521
+ "$ref": "#/components/schemas/Reference3_array",
522
+ "description": "This is an object reference."
523
+ }
524
+ }
525
+ },
526
+ "Reference3_array": {
527
+ "type": "array",
528
+ "items": {
529
+ "$ref": "#/components/schemas/Reference3"
530
+ }
531
+ },
532
+ "Reference3": {
533
+ "type": "object",
534
+ "properties": {
535
+ "someBoolean": {
536
+ "type": "boolean"
537
+ }
538
+ }
539
+ },
540
+ "Reference4": {
541
+ "type": "object",
542
+ "properties": {
543
+ "someString": {
544
+ "type": "string"
545
+ }
546
+ }
547
+ },
548
+ "Reference5": {
549
+ "type": "object",
550
+ "properties": {
551
+ "reference6Member": {
552
+ "$ref": "#/components/schemas/Reference6"
553
+ }
554
+ }
555
+ },
556
+ "Reference6": {
557
+ "type": "object",
558
+ "properties": {
559
+ "grandChildString": {
560
+ "type": "string",
561
+ "description": "This is the grandchild description."
562
+ }
563
+ }
564
+ },
565
+ "Reference1_array": {
566
+ "type": "array",
567
+ "items": {
568
+ "$ref": "#/components/schemas/Reference1"
569
+ }
570
+ },
571
+ "Reference7_Reference7[untypedObject:Reference2]": {
572
+ "type": "object",
573
+ "properties": {
574
+ "untypedObject": {
575
+ "$ref": "#/components/schemas/Reference2"
576
+ }
577
+ }
578
+ },
579
+ "SampleRestResourceWithInnerClass.InnerClass": {
580
+ "type": "object",
581
+ "properties": {
582
+ "stringMember": {
583
+ "type": "string"
584
+ }
585
+ }
586
+ }
587
+ }
588
+ }
589
+ }
package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls CHANGED
@@ -1,35 +1,35 @@
1
- /**
2
- * @description This rest resource should be skipped
3
- * @ignore
4
- */
5
- @RestResource(UrlMapping='/ResourceToSkip/*')
6
- global with sharing class SampleRestResourceToSkip {
7
- @HttpDelete
8
- global static void doDelete() {
9
- RestRequest req = RestContext.request;
10
- RestResponse res = RestContext.response;
11
- String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
12
- Account account = [SELECT Id FROM Account WHERE Id = :accountId];
13
- delete account;
14
- }
15
-
16
- @HttpGet
17
- global static Account doGet() {
18
- RestRequest req = RestContext.request;
19
- RestResponse res = RestContext.response;
20
- String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
21
- Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
22
- return result;
23
- }
24
-
25
- @HttpPost
26
- global static String doPost(String name,
27
- String phone, String website) {
28
- Account account = new Account();
29
- account.Name = name;
30
- account.phone = phone;
31
- account.website = website;
32
- insert account;
33
- return account.Id;
34
- }
35
- }
1
+ /**
2
+ * @description This rest resource should be skipped
3
+ * @ignore
4
+ */
5
+ @RestResource(UrlMapping='/ResourceToSkip/*')
6
+ global with sharing class SampleRestResourceToSkip {
7
+ @HttpDelete
8
+ global static void doDelete() {
9
+ RestRequest req = RestContext.request;
10
+ RestResponse res = RestContext.response;
11
+ String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
12
+ Account account = [SELECT Id FROM Account WHERE Id = :accountId];
13
+ delete account;
14
+ }
15
+
16
+ @HttpGet
17
+ global static Account doGet() {
18
+ RestRequest req = RestContext.request;
19
+ RestResponse res = RestContext.response;
20
+ String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
21
+ Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
22
+ return result;
23
+ }
24
+
25
+ @HttpPost
26
+ global static String doPost(String name,
27
+ String phone, String website) {
28
+ Account account = new Account();
29
+ account.Name = name;
30
+ account.phone = phone;
31
+ account.website = website;
32
+ insert account;
33
+ return account.Id;
34
+ }
35
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cparra/apexdocs",
3
- "version": "2.13.0",
3
+ "version": "2.13.1",
4
4
  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
5
5
  "keywords": [
6
6
  "apex",
@@ -66,7 +66,7 @@
66
66
  ]
67
67
  },
68
68
  "dependencies": {
69
- "@cparra/apex-reflection": "2.3.0",
69
+ "@cparra/apex-reflection": "2.3.1",
70
70
  "chalk": "^4.1.2",
71
71
  "fast-xml-parser": "^4.0.1",
72
72
  "js-yaml": "^4.1.0",