-
Notifications
You must be signed in to change notification settings - Fork 770
/
Copy pathindex.html
5784 lines (4603 loc) · 444 KB
/
index.html
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
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="main.css">
<meta charset="UTF-8">
<title>ycmd</title>
</head>
<body>
<div class="container">
<h1>ycmd</h1>
<p class="sw-info">
Version: <span class="sw-info-version">0.3.0</span>, <a href="https://github.com/Valloric/ycmd" class="sw-external-doc">ycmd GitHub page</a>
</p>
<p><p>ycmd is a code-completion & code-comprehension server.</p>
<p>ycmd presents a JSON/REST interface to clients over HTTP, validated by HMAC.
An instance of ycmd is started for each client application.</p>
<h2 id="general-notes">General Notes</h2>
<p>The REST interface typically uses HTTP POST requests and expects the payload
data to be a valid JSON document. The following general principles are
applied:</p>
<ul>
<li>All strings going into and out of the server are UTF-8 encoded.</li>
<li>All lines end with <code>\n</code>.</li>
<li>All line and column numbers are 1-based, not 0-based. They are also byte
offsets, not Unicode codepoint offsets.</li>
<li>All file paths are full, absolute paths. If a file has not been written
to disk yet, supply a temporary path.</li>
<li>All requests to the server must include an HMAC in the x-ycm-hmac HTTP
header.</li>
<li>All responses from the server must be validated using the x-ycm-hmac
header.</li>
</ul>
<h2 id="the-example-client">The example client</h2>
<p>ycmd contains a simple example client in the <code>example</code> directory of the
source tree. It is written in pure Python with only minimal dependencies.
It contains trivial implementations of most endpoints and serves to
supplement this API documentation.</p>
<p>Consult <code>example/README.md</code> for instructions on getting it running.</p>
<h2 id="starting-the-server">Starting the server</h2>
<p>The ycmd server is typically started by a client in order to provide
services to it. Briefly, starting the server requires supplying some
configuration and initializing some security features (HMAC).</p>
<p>The server should be started with a supported version of Python.</p>
<p>The full list of command line options can be obtained by passing <code>--help</code>
to ycmd (e.g. <code>python -m ycmd --help</code>). However, the following
options warrant further discussion:</p>
<h3 id="-options_file"><code>--options_file</code></h3>
<p>This mandatory option supplies the name of a file containing user options
data. This option (and thus the file) are mandatory, as they are required
to set the shared HMAC secret.</p>
<p>Once the server has read the options, the server deletes the options file.
Therefore, the client should typically create a secure temporary file (e.g.
<code>mkstemp</code>) which contains the options to be used.</p>
<p>The default options and their values are found in <code>default_settings.json</code>
within the ycmd codebase.</p>
<p>The file contains a JSON-formatted object, where the keys are the names of
options (with any <code>ycm_</code> prefix removed) and the values are the option
values.</p>
<p>The canonical list of supported user options can be found in
YouCompleteMe's <code>README.md</code>. The option values should have the <code>ycm_</code>
prefix removed.</p>
<p>The following additional options are required to be set by the client
application and should <em>not</em> be visible to the user:</p>
<ul>
<li><code>hmac_secret</code>: The shared secret for HMAC authentication. This should be
16 bytes of random data with as much entropy as possible, encoded as a
base-64 UTF-8 string. Code for generating this in Python can be found
in the ycmd example client.</li>
</ul>
<h2 id="hmac">HMAC</h2>
<p>All requests to the server must include an HMAC in the x-ycm-hmac HTTP
header. The HMAC is computed from the shared secret passed to the server
on startup and the request/response body. The digest algorithm is SHA-256.
The server will also include the HMAC in its responses; you must verify it
before using the response. See the example client to see how it's done.</p>
<h2 id="filetypes">Filetypes</h2>
<p>ycmd uses <code>filetypes</code> to identify the "language" of a given buffer. These
filetype values are strictly the values understood by Vim. Please see the
YCM README.md for the list of filetypes recognized by ycmd for semantic
completion.</p>
</p>
<div id="sw-schemes" class="sw-default-value">
<span class="sw-default-value-header">Schemes:</span>
</div>
<h2 id="swagger--summary-no-tags">Summary</h2>
<table class="table table-bordered table-condensed swagger--summary">
<thead>
<tr>
<th>Path</th>
<th>Operation</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--completions">/completions</a>
</td>
<td>
<a href="#operation--completions-post">POST</a>
</td>
<td>
<p>Get completion suggestions for the current file context.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--debug_info">/debug_info</a>
</td>
<td>
<a href="#operation--debug_info-post">POST</a>
</td>
<td>
<p>Return server and semantic engine debug information.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--defined_subcommands">/defined_subcommands</a>
</td>
<td>
<a href="#operation--defined_subcommands-post">POST</a>
</td>
<td>
<p>Get the list of subcommands which are available for a completer.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--detailed_diagnostic">/detailed_diagnostic</a>
</td>
<td>
<a href="#operation--detailed_diagnostic-post">POST</a>
</td>
<td>
<p>Get additional information about diagnostic under cursor.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--event_notification">/event_notification</a>
</td>
<td>
<a href="#operation--event_notification-post">POST</a>
</td>
<td>
<p>Notify the server of various client events.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--filter_and_sort_candidates">/filter_and_sort_candidates</a>
</td>
<td>
<a href="#operation--filter_and_sort_candidates-post">POST</a>
</td>
<td>
<p>Filter and sort a set of candidates using ycmd's fuzzy matching.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--healthy">/healthy</a>
</td>
<td>
<a href="#operation--healthy-get">GET</a>
</td>
<td>
<p>Check if the server is healthy.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--ignore_extra_conf_file">/ignore_extra_conf_file</a>
</td>
<td>
<a href="#operation--ignore_extra_conf_file-post">POST</a>
</td>
<td>
<p>Forcefully ignore the config for the current buffer.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--inlay_hints">/inlay_hints</a>
</td>
<td>
<a href="#operation--inlay_hints-post">POST</a>
</td>
<td>
<p>Compute inlay hints for a range</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--load_extra_conf_file">/load_extra_conf_file</a>
</td>
<td>
<a href="#operation--load_extra_conf_file-post">POST</a>
</td>
<td>
<p>Forcefully load the config for the current buffer.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--ready">/ready</a>
</td>
<td>
<a href="#operation--ready-get">GET</a>
</td>
<td>
<p>Check if the server is ready.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--receive_messages">/receive_messages</a>
</td>
<td>
<a href="#operation--receive_messages-post">POST</a>
</td>
<td>
<p>Long poll for asynchronous server messages.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--resolve_completion">/resolve_completion</a>
</td>
<td>
<a href="#operation--resolve_completion-post">POST</a>
</td>
<td>
<p>Resolve detailed_info for a completion item</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--resolve_fixit">/resolve_fixit</a>
</td>
<td>
<a href="#operation--resolve_fixit-post">POST</a>
</td>
<td>
<p>Resolve an incomplete FixIt.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--run_completer_command">/run_completer_command</a>
</td>
<td>
<a href="#operation--run_completer_command-post">POST</a>
</td>
<td>
<p>Run a semantic completer subcommand.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--semantic_completion_available">/semantic_completion_available</a>
</td>
<td>
<a href="#operation--semantic_completion_available-post">POST</a>
</td>
<td>
<p>Determine if semantic completion is available for current buffer.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--semantic_tokens">/semantic_tokens</a>
</td>
<td>
<a href="#operation--semantic_tokens-post">POST</a>
</td>
<td>
<p>Compute semantic tokens for a range, or the whole document</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--shutdown">/shutdown</a>
</td>
<td>
<a href="#operation--shutdown-post">POST</a>
</td>
<td>
<p>Request ycmd to shut down.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--signature_help">/signature_help</a>
</td>
<td>
<a href="#operation--signature_help-post">POST</a>
</td>
<td>
<p>Get signature help (argument hints) for current file context.</p>
</td>
</tr>
<tr>
<td class="swagger--summary-path" rowspan="1">
<a href="#path--signature_help_available">/signature_help_available</a>
</td>
<td>
<a href="#operation--signature_help_available-get">GET</a>
</td>
<td>
<p>Is /signature_help supported for some filetype</p>
</td>
</tr>
</tbody>
</table>
<h2>Paths</h2>
<span id="path--completions"></span>
<div id="operation--completions-post" class="swagger--panel-operation-post panel">
<div class="panel-heading">
<div class="operation-summary">Get completion suggestions for the current file context.</div>
<h3 class="panel-title"><span class="operation-name">POST</span> <strong>/completions</strong></h3>
</div>
<div class="panel-body">
<section class="sw-operation-description">
<p>Returns the autocompletion suggestions for the current cursor
position. Typically, the server determines whether or not to use
semantic completion or general (i.e. identifier-based) completion
based on the language (filetype) and the context. Clients can force
the use of semantic completion by setting the <code>force_semantic</code>
property to <code>true</code>.</p>
<p>Note that if <code>force_semantic</code> is not set to <code>true</code> and the completion
engine returns an error, the server still tries to fall back to
general completion, so this endpoint will typically always return
successfully. Any semantic completer error raised is included in the
response to be dealt with by the client.</p>
<p>When <code>force_semantic</code> is <code>true</code>, any error returned by the semantic
engine is returned via a 500 response.</p>
</section>
<section class="sw-request-body">
<div class="row">
<div class="col-md-6">
<p><p>The context data, including the current cursor position, and details
of dirty buffers.</p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
</div>
</div></div>
</div>
</section>
<section class="sw-responses">
<p><span class="label label-default">application/json</span>
</p>
<dl>
<dt class="sw-response-200">
200 OK
</dt>
<dd class="sw-response-200">
<div class="row">
<div class="col-md-12">
<p>The list of completion suggestions.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/CompletionResponse">CompletionResponse</a>
</div>
</div></div>
</div> </dd>
<dt class="sw-response-500">
500 Internal Server Error
</dt>
<dd class="sw-response-500">
<div class="row">
<div class="col-md-12">
<p>An error occurred.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
</div>
</div></div>
</div> </dd>
</dl>
</section>
</div>
</div>
<span id="path--debug_info"></span>
<div id="operation--debug_info-post" class="swagger--panel-operation-post panel">
<div class="panel-heading">
<div class="operation-summary">Return server and semantic engine debug information.</div>
<h3 class="panel-title"><span class="operation-name">POST</span> <strong>/debug_info</strong></h3>
</div>
<div class="panel-body">
<section class="sw-operation-description">
<p>Returns debugging information about the server itself and the
semantic completer for the current buffer (if there is one).</p>
<p>This data includes things like the versions of linked-in libraries,
log file locations, etc.</p>
</section>
<section class="sw-request-body">
<div class="row">
<div class="col-md-6">
<p><p>The context data, including the current cursor position, and details
of dirty buffers.</p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
</div>
</div></div>
</div>
</section>
<section class="sw-responses">
<p><span class="label label-default">application/json</span>
</p>
<dl>
<dt class="sw-response-200">
200 OK
</dt>
<dd class="sw-response-200">
<div class="row">
<div class="col-md-12">
<p>A dictionary of debugging information.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 sw-response-examples">
<div class="label label-default">Example for application/json</div>
<pre>{<br> "<span class="hljs-attribute">clang</span>": <span class="hljs-value">{<br> "<span class="hljs-attribute">has_support</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,<br> "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"clang version"</span><br> </span>}</span>,<br> "<span class="hljs-attribute">completer</span>": <span class="hljs-value">{<br> "<span class="hljs-attribute">items</span>": <span class="hljs-value">[<br> {<br> "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"description"</span></span>,<br> "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">"value"</span><br> </span>}<br> ]</span>,<br> "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"completer name"</span></span>,<br> "<span class="hljs-attribute">servers</span>": <span class="hljs-value">[<br> {<br> "<span class="hljs-attribute">address</span>": <span class="hljs-value"><span class="hljs-string">"127.0.0.1"</span></span>,<br> "<span class="hljs-attribute">executable</span>": <span class="hljs-value"><span class="hljs-string">"/path/to/executable"</span></span>,<br> "<span class="hljs-attribute">extras</span>": <span class="hljs-value">[<br> {<br> "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"description"</span><br> </span>},<br> {<br> "<span class="hljs-attribute">value</span>": <span class="hljs-value"><span class="hljs-string">"value"</span><br> </span>}<br> ]</span>,<br> "<span class="hljs-attribute">is_running</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,<br> "<span class="hljs-attribute">logfiles</span>": <span class="hljs-value">[<br> <span class="hljs-string">"/path/to/stdout/logfile"</span>,<br> <span class="hljs-string">"/path/to/stderr/logfile"</span><br> ]</span>,<br> "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"server name"</span></span>,<br> "<span class="hljs-attribute">pid</span>": <span class="hljs-value"><span class="hljs-number">12345</span></span>,<br> "<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">1234</span><br> </span>}<br> ]<br> </span>}</span>,<br> "<span class="hljs-attribute">extra_conf</span>": <span class="hljs-value">{<br> "<span class="hljs-attribute">is_loaded</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,<br> "<span class="hljs-attribute">path</span>": <span class="hljs-value"><span class="hljs-string">"/path/to/extra/conf"</span><br> </span>}</span>,<br> "<span class="hljs-attribute">python</span>": <span class="hljs-value">{<br> "<span class="hljs-attribute">executable</span>": <span class="hljs-value"><span class="hljs-string">"/path/to/python/interpreter"</span></span>,<br> "<span class="hljs-attribute">version</span>": <span class="hljs-value"><span class="hljs-string">"python version"</span><br> </span>}<br></span>}</pre>
</div>
<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<section class="json-schema-properties">
<dl>
<dt data-property-name="python">
<span class="json-property-name">python:</span>
<span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p>Debugging information on the Python interpreter in which the
server is running.</p>
<div class="json-inner-schema">
<section class="json-schema-properties">
<dl>
<dt data-property-name="executable">
<span class="json-property-name">executable:</span>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p>Python interpreter path.</p>
<div class="json-inner-schema">
</div>
</dd>
<dt data-property-name="version">
<span class="json-property-name">version:</span>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p>Python interpreter version.</p>
<div class="json-inner-schema">
</div>
</dd>
</dl>
</section>
</div>
</dd>
<dt data-property-name="clang">
<span class="json-property-name">clang:</span>
<span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p>Debugging information on Clang.</p>
<div class="json-inner-schema">
<section class="json-schema-properties">
<dl>
<dt data-property-name="has_support">
<span class="json-property-name">has_support:</span>
<span class="json-property-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p><code>true</code> if the ycmd server was built with Clang support,
<code>false</code> otherwise.</p>
<div class="json-inner-schema">
</div>
</dd>
<dt data-property-name="version">
<span class="json-property-name">version:</span>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p>if <code>has_support</code> is <code>true</code>, return the version of Clang.
Otherwise, return <code>null</code>.</p>
<div class="json-inner-schema">
</div>
</dd>
</dl>
</section>
</div>
</dd>
<dt data-property-name="extra_conf">
<span class="json-property-name">extra_conf:</span>
<span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p>Debugging information on the extra configuration file for the
current buffer.</p>
<div class="json-inner-schema">
<section class="json-schema-properties">
<dl>
<dt data-property-name="path">
<span class="json-property-name">path:</span>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p>Path of the found extra configuration file, loaded or not.</p>
<div class="json-inner-schema">
</div>
</dd>
<dt data-property-name="is_loaded">
<span class="json-property-name">is_loaded:</span>
<span class="json-property-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p><code>true</code> if the extra configuration file is loaded, <code>false</code>
otherwise.</p>
<div class="json-inner-schema">
</div>
</dd>
</dl>
</section>
</div>
</dd>
<dt data-property-name="completer">
<span class="json-property-name">completer:</span>
<span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/DebugInfoResponse">DebugInfoResponse</a>
</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p>Contains debugging information on the completer for the given
filetypes. <code>null</code> if no completer is available.</p>
<div class="json-inner-schema">
</div>
</dd>
</dl>
</section>
</div>
</div></div>
</div> </dd>
<dt class="sw-response-500">
500 Internal Server Error
</dt>
<dd class="sw-response-500">
<div class="row">
<div class="col-md-12">
<p>An error occurred.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
</div>
</div></div>
</div> </dd>
</dl>
</section>
</div>
</div>
<span id="path--defined_subcommands"></span>
<div id="operation--defined_subcommands-post" class="swagger--panel-operation-post panel">
<div class="panel-heading">
<div class="operation-summary">Get the list of subcommands which are available for a completer.</div>
<h3 class="panel-title"><span class="operation-name">POST</span> <strong>/defined_subcommands</strong></h3>
</div>
<div class="panel-body">
<section class="sw-operation-description">
<p>Returns the list of completer subcommands for a given completer.</p>
<p>See also: <code>/run_completer_command</code></p>
</section>
<section class="sw-request-body">
<div class="row">
<div class="col-md-6">
<p><p>The context data, including the current cursor position, and details
of dirty buffers.</p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
</div>
</div></div>
</div>
</section>
<section class="sw-responses">
<p><span class="label label-default">application/json</span>
</p>
<dl>
<dt class="sw-response-200">
200 OK
</dt>
<dd class="sw-response-200">
<div class="row">
<div class="col-md-12">
<p>The list of available subcommands.</p>
</div>
</div>
<div class="row">
<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<section class="json-schema-array-items">
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
<div class="json-inner-schema">
</div>
</section> </div>
</div></div>
</div> </dd>
<dt class="sw-response-500">
500 Internal Server Error
</dt>
<dd class="sw-response-500">
<div class="row">
<div class="col-md-12">
<p>An error occurred</p>
</div>
</div>
<div class="row">
<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
</div>
</div></div>
</div> </dd>
</dl>
</section>
</div>
</div>
<span id="path--detailed_diagnostic"></span>
<div id="operation--detailed_diagnostic-post" class="swagger--panel-operation-post panel">
<div class="panel-heading">
<div class="operation-summary">Get additional information about diagnostic under cursor.</div>
<h3 class="panel-title"><span class="operation-name">POST</span> <strong>/detailed_diagnostic</strong></h3>
</div>
<div class="panel-body">
<section class="sw-operation-description">
<p>Where available returns addition information about the diagnostic, such
as the full text of the compile error, suggestions, etc.</p>
<p>Typically, details are returned for the diagnostic nearest to the
current cursor position.</p>
</section>
<section class="sw-request-body">
<div class="row">
<div class="col-md-6">
<p><p>The context data, including the current cursor position, and details
of dirty buffers.</p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/SimpleRequest">SimpleRequest</a>
</div>
</div></div>
</div>
</section>
<section class="sw-responses">
<p><span class="label label-default">application/json</span>
</p>
<dl>
<dt class="sw-response-200">
200 OK
</dt>
<dd class="sw-response-200">
<div class="row">
<div class="col-md-12">
<p>The detailed diagnostic</p>
</div>
</div>
<div class="row">
<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<section class="json-schema-properties">
<dl>
<dt data-property-name="message">
<span class="json-property-name">message:</span>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-required"></span>
</dt>
<dd>
<div class="json-inner-schema">
</div>
</dd>
</dl>
</section>
</div>
</div></div>
</div> </dd>
<dt class="sw-response-500">
500 Internal Server Error
</dt>
<dd class="sw-response-500">
<div class="row">
<div class="col-md-12">
<p>An error occurred, or no diagnostic was available</p>
</div>
</div>
<div class="row">
<div class="col-md-6 sw-response-model">
<div class="panel panel-definition">
<div class="panel-body">
<a class="json-schema-ref" href="#/definitions/ExceptionResponse">ExceptionResponse</a>
</div>
</div></div>
</div> </dd>
</dl>
</section>
</div>
</div>
<span id="path--event_notification"></span>
<div id="operation--event_notification-post" class="swagger--panel-operation-post panel">
<div class="panel-heading">
<div class="operation-summary">Notify the server of various client events.</div>
<h3 class="panel-title"><span class="operation-name">POST</span> <strong>/event_notification</strong></h3>
</div>
<div class="panel-body">
<section class="sw-operation-description">
<p>The server needs to react to a number of client events in order to
provide things like diagnostics and to handle downstream server states
etc. The client must inform the server of the following events,
populating the event name in the <code>event_name</code> property:</p>
<ul>
<li><code>FileReadyToParse</code>
Call when a new buffer is opened or after the user has
stopped typing for some time, or at any other time when the client
believes that it is worthwhile reparsing the current file and
updating semantic engines' ASTs and reporting things like updated
diagnostics.</li>
<li><code>BufferUnload</code>
Call when the user closes a buffer that was previously known to be
open. Closing buffers is important to limit resource usage.</li>
<li><code>BufferVisit</code> (optional)
Call when the user focuses on a buffer that is already known.
<em>Note</em>: The <code>ultisnips_snippets</code> property is optional when firing
calling this event. Otherwise it is ignored.</li>
<li><code>InsertLeave</code> (optional)
For modal editors, call when exiting insert mode. It is equivalent
to <code>CurrentIdentifierFinished</code>.</li>
<li><code>CurrentIdentifierFinished</code> (optional)
Call when the user finishes typing what appears to the client to be
an identifier.</li>
<li><code>FileSave</code>
Call when the user writes to a file on disk. (optional)</li>
</ul>
</section>
<section class="sw-request-body">
<div class="row">
<div class="col-md-6">
<p><p>The notification data. The line and column are typically not used,
but the <code>filepath</code> and file data properties are used to perform
semantic analysis (e.g. in the <code>FileReadyToParse</code> handler).</p>
</p>
</div>
<div class="col-md-6 sw-request-model">
<div class="panel panel-definition">
<div class="panel-body">
<section class="json-schema-example">
<pre><code class="lang-json">{<br> "<span class="hljs-attribute">column_num</span>": <span class="hljs-value"><span class="hljs-number">20</span></span>,<br> "<span class="hljs-attribute">event_name</span>": <span class="hljs-value"><span class="hljs-string">"FileReadyToParse"</span></span>,<br> "<span class="hljs-attribute">file_data</span>": <span class="hljs-value">{<br> "<span class="hljs-attribute">/home/test/dev/test.cc</span>": <span class="hljs-value">{<br> "<span class="hljs-attribute">contents</span>": <span class="hljs-value"><span class="hljs-string">"<file contents>"</span></span>,<br> "<span class="hljs-attribute">filetypes</span>": <span class="hljs-value">[<br> <span class="hljs-string">"cpp"</span><br> ]<br> </span>}<br> </span>}</span>,<br> "<span class="hljs-attribute">filepath</span>": <span class="hljs-value"><span class="hljs-string">"/home/test/dev/test.js"</span></span>,<br> "<span class="hljs-attribute">line_num</span>": <span class="hljs-value"><span class="hljs-number">10</span><br></span>}
</code></pre>
</section>
<section class="json-schema-properties">
<dl>
<dt data-property-name="line_num">
<span class="json-property-name">line_num:</span>
<span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/LineNumber">LineNumber</a>
</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-required"></span>
</dt>
<dd>
<div class="json-inner-schema">
</div>
</dd>
<dt data-property-name="column_num">
<span class="json-property-name">column_num:</span>
<span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/ColumnNumber">ColumnNumber</a>
</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-required"></span>
</dt>
<dd>
<div class="json-inner-schema">
</div>
</dd>
<dt data-property-name="filepath">
<span class="json-property-name">filepath:</span>
<span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/FilePath">FilePath</a>
</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-required"></span>
</dt>
<dd>
<div class="json-inner-schema">
</div>
</dd>
<dt data-property-name="file_data">
<span class="json-property-name">file_data:</span>
<span class="json-property-type"> <a class="json-schema-ref" href="#/definitions/FileDataMap">FileDataMap</a>
</span>
<span class="json-property-range" title="Value limits"></span>
<span class="json-property-required"></span>