Repository navigation
Expand file tree
/
Copy pathapi.yaml
More file actions
628 lines (628 loc) · 18.3 KB
/
Copy pathapi.yaml
File metadata and controls
628 lines (628 loc) · 18.3 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
openapi: 3.0.0
info:
title: LSIF API Server
description: An internal Sourcegraph microservice that serves LSIF-powered code intelligence.
version: 1.0.0
contact:
name: Eric Fritz
email: eric@sourcegraph.com
url: https://sourcegraph.com
servers:
- url: http://localhost:3186
tags:
- name: LSIF
description: LSIF operations
- name: Uploads
description: Upload operations
- name: Internal
description: Internal operations
paths:
/upload:
post:
description: Upload LSIF data for a particular commit and directory. Exactly one file must be uploaded, and it is assumed to be the gzipped output of an LSIF indexer.
tags:
- LSIF
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
parameters:
- name: repositoryId
in: query
description: The repository identifier.
required: true
schema:
type: number
- name: commit
in: query
description: The 40-character commit hash.
required: true
schema:
type: string
- name: root
in: query
description: The path to the directory associated with the upload, relative to the repository root.
example: cmd/project1
required: false
schema:
type: string
- name: indexerName
in: query
description: The name of the indexer that generated the payload. This is required only if there is no tool info supplied in the payload's metadata vertex.
required: false
schema:
type: string
responses:
'200':
description: Processed (synchronously)
content:
application/json:
schema:
$ref: '#/components/schemas/EnqueueResponse'
'202':
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/EnqueueResponse'
/exists:
get:
description: Determine if LSIF data exists for a file within a particular commit. This endpoint will return the LSIF upload for which definitions, references, and hover queries will use.
tags:
- LSIF
parameters:
- name: repositoryId
in: query
description: The repository identifier.
required: true
schema:
type: number
- name: commit
in: query
description: The 40-character commit hash.
required: true
schema:
type: string
- name: path
in: query
description: The file path within the repository (relative to the repository root).
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
- $ref: '#/components/schemas/Uploads'
post:
description: Determine if LSIF data exists for a file within a particular commit. This endpoint will return true if there is a nearby commit (direct ancestor or descendant) with LSIF data for the same file if the exact commit does not have available LSIF data.
tags:
- LSIF
parameters:
- name: repositoryId
in: query
description: The repository identifier.
required: true
schema:
type: number
- name: commit
in: query
description: The 40-character commit hash.
required: true
schema:
type: string
- name: file
in: query
description: The file path within the repository (relative to the repository root).
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: boolean
/definitions:
get:
description: Get definitions for the symbol at a source position.
tags:
- LSIF
parameters:
- name: repositoryId
in: query
description: The repository identifier.
required: true
schema:
type: number
- name: commit
in: query
description: The 40-character commit hash.
required: true
schema:
type: number
- name: path
in: query
description: The file path within the repository (relative to the repository root).
required: true
schema:
type: string
- name: line
in: query
description: The line index (zero-indexed).
required: true
schema:
type: number
- name: character
in: query
description: The character index (zero-indexed).
required: true
schema:
type: number
- name: uploadId
in: query
description: The identifier of the upload to load. If not supplied, the upload nearest to the given commit will be loaded.
required: true
schema:
type: number
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Locations'
'404':
description: Not found
/references:
get:
description: Get references for the symbol at a source position.
tags:
- LSIF
parameters:
- name: repositoryId
in: query
description: The repository identifier.
required: true
schema:
type: number
- name: commit
in: query
description: The 40-character commit hash.
required: true
schema:
type: number
- name: path
in: query
description: The file path within the repository (relative to the repository root).
required: true
schema:
type: string
- name: line
in: query
description: The line index (zero-indexed).
required: true
schema:
type: number
- name: character
in: query
description: The character index (zero-indexed).
required: true
schema:
type: number
- name: uploadId
in: query
description: The identifier of the upload to load. If not supplied, the upload nearest to the given commit will be loaded.
required: true
schema:
type: number
- name: limit
in: query
description: The maximum number of locations to return in one page.
required: false
schema:
type: number
default: 10
- name: cursor
in: query
description: The end cursor given in the response of a previous page.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Locations'
headers:
Link:
description: If there are more results, this header includes the URL of the next page with relation type *next*. See [RFC 5988](https://tools.ietf.org/html/rfc5988).
schema:
type: string
'404':
description: Not found
/hover:
get:
description: Get hover data for the symbol at a source position.
tags:
- LSIF
parameters:
- name: repositoryId
in: query
description: The repository identifier.
required: true
schema:
type: number
- name: commit
in: query
description: The 40-character commit hash.
required: true
schema:
type: number
- name: path
in: query
description: The file path within the repository (relative to the repository root).
required: true
schema:
type: string
- name: line
in: query
description: The line index (zero-indexed).
required: true
schema:
type: number
- name: character
in: query
description: The character index (zero-indexed).
required: true
schema:
type: number
- name: uploadId
in: query
description: The identifier of the upload to load. If not supplied, the upload nearest to the given commit will be loaded.
required: true
schema:
type: number
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Hover'
'404':
description: Not found
/uploads/repositories/{repositoryId}:
get:
description: Get LSIF uploads for a repository.
tags:
- Uploads
parameters:
- name: repositoryId
in: query
description: The repository identifier.
required: true
schema:
type: number
- name: query
in: query
description: A search query applied over commit, root, failure reason, and failure stacktrace properties.
required: false
schema:
type: string
- name: state
in: query
description: The target upload state.
required: true
schema:
type: string
enum:
- processing
- errored
- completed
- queued
- name: visibleAtTip
in: query
description: If true, only show uploads visible at tip.
required: false
schema:
type: boolean
- name: limit
in: query
description: The maximum number of uploads to return in one page.
required: false
schema:
type: number
default: 50
- name: offset
in: query
description: The number of uploads seen on previous pages.
required: false
schema:
type: number
default: 0
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedUploads'
headers:
Link:
description: If there are more results, this header includes the URL of the next page with relation type *next*. See [RFC 5988](https://tools.ietf.org/html/rfc5988).
schema:
type: string
/uploads/{id}:
get:
description: Get an LSIF upload by its identifier.
tags:
- Uploads
parameters:
- name: id
in: path
description: The upload identifier.
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Upload'
'404':
description: Not Found
delete:
description: Delete an LSIF upload by its identifier.
tags:
- Uploads
parameters:
- name: id
in: path
description: The upload identifier.
required: true
schema:
type: string
responses:
'200':
description: No Content
'404':
description: Not Found
/states:
get:
description: Retrieve the state of a set of uploads by identifier.
tags:
- Internal
requestBody:
content:
application/json:
schema:
type: object
properties:
ids:
description: The upload identifier list.
type: array
items:
type: number
additionalProperties: false
required:
- ids
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
type:
type: string
const: 'map'
values:
description: A list of key/value pairs.
type: array
items:
description: A key/value pair.
type: array
items:
oneOf:
- type: number
- type: string
additionalProperties: false
required:
- type
- values
/prune:
post:
description: Remove the oldest prunable dump.
tags:
- Internal
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
description: The identifier of the pruned dump.
type: number
additionalProperties: false
required:
- id
nullable: true
components:
schemas:
Position:
type: object
description: A cursor position in a source file.
properties:
line:
type: number
description: The (zero-index) line index.
character:
type: number
description: The (zero-index) character index.
required:
- line
- character
additionalProperties: false
Range:
type: object
description: A half-open range of positions in a source file.
properties:
start:
$ref: '#/components/schemas/Position'
end:
$ref: '#/components/schemas/Position'
required:
- start
- end
additionalProperties: false
Location:
type: object
description: A position in a file of a code base.
properties:
repositoryId:
type: number
description: The identifier of the repository in which the location occurs.
commit:
type: string
description: The commit in which the location occurs.
path:
type: string
description: The root-relative path to the file.
range:
$ref: '#/components/schemas/Range'
required:
- repositoryId
- commit
- path
- range
additionalProperties: false
Locations:
type: array
description: A list of definition or reference locations.
items:
$ref: '#/components/schemas/Location'
Hover:
type: object
description: The text associated with a position in a source file.
properties:
text:
type: string
description: The raw hover text.
required:
- text
additionalProperties: false
EnqueueResponse:
type: object
description: A payload indicating the enqueued upload.
properties:
id:
type: number
description: The upload identifier.
required:
- id
additionalProperties: false
Uploads:
type: object
description: A wrapper for a list of uploads.
properties:
uploads:
type: array
description: A list of uploads.
items:
$ref: '#/components/schemas/Upload'
PaginatedUploads:
type: object
description: A paginated wrapper for a list of uploads.
properties:
uploads:
type: array
description: A list of uploads with a particular state.
items:
$ref: '#/components/schemas/Upload'
totalCount:
type: number
description: The total number of uploads in this set of results.
required:
- uploads
additionalProperties: false
Upload:
type: object
description: An LSIF upload.
properties:
id:
type: number
description: A unique identifier.
repositoryId:
type: number
description: The repository identifier argument given on upload.
commit:
type: string
description: The commit argument given on upload.
root:
type: string
description: The root argument given on upload.
indexer:
type: string
description: The name of the indexer given on upload.
filename:
type: string
description: The filename where the upload was stored before conversion.
state:
type: string
description: The upload's current state.
enum:
- processing
- errored
- completed
- queued
failureSummary:
type: string
description: A brief description of why the upload conversion failed.
failureStacktrace:
type: string
description: The stacktrace of the upload error.
uploadedAt:
type: string
description: An RFC3339-formatted time that the upload was uploaded.
startedAt:
type: string
description: An RFC3339-formatted time that the conversion started.
nullable: true
finishedAt:
type: string
description: An RFC3339-formatted time that the conversion completed or errored.
nullable: true
visibleAtTip:
type: boolean
description: Whether or not this upload can provide global reference code intelligence.
placeInQueue:
type: number
description: The rank of this upload in the queue. The value of this field is null if the upload has been processed.
nullable: true
required:
- id
- repositoryId
- commit
- root
- filename
- state
- failureSummary
- failureStacktrace
- uploadedAt
- startedAt
- finishedAt
additionalProperties: false