1
1
mirror of https://github.com/github/semantic.git synced 2024-12-25 16:02:43 +03:00
semantic/proto/code_analysis.proto

92 lines
1.9 KiB
Protocol Buffer

syntax = "proto3";
import "types.proto";
import "error_details.proto";
option java_package = "com.github.semantic.analysis";
option go_package = "github.com/semantic/analysis/;analysis";
package github.semantic;
// Semantic's CodeAnalysis service provides endpoints for parsing, analyzing, and
// comparing source code.
service CodeAnalysis {
// Parsing
//
// Parse source code blobs and return abstract syntax trees.
rpc ParseTree(ParseTreeRequest) returns (ParseTreeResponse);
// Diffing
//
// Summarize an AST diff of source blobs.
rpc SummarizeDiff (SummarizeDiffRequest) returns (SummarizeDiffResponse);
// AST diff of source blobs
// rpc Diff (DiffRequest) returns (DiffResponse) {}
// Analyzing
//
// Calculate an import graph for a project.
rpc GraphImports (ImportGraphRequest) returns (ImportGraphResponse);
// rpc GraphCalls (CallGraphRequest) returns (CallGraphResponse);
// Check health & status of the service.
rpc CheckHealth (HealthCheckRequest) returns (HealthCheckResponse);
}
message ParseTreeRequest {
repeated Blob blobs = 1;
}
message ParseTreeResponse {
bytes json_tree = 1;
repeated ParseError errors = 2;
}
message SummarizeDiffRequest {
repeated BlobPair blobPairs = 1;
}
message SummarizeDiffResponse {
repeated DiffSummary changes = 1;
repeated ParseError errors = 2;
}
message ImportGraphRequest {
Project project = 1;
}
message ImportGraphResponse {
AdjList graph = 1;
DebugInfo error_info = 2;
}
message BlobPair {
Blob before = 1;
Blob after = 2;
}
message DiffSummary {
string term = 1;
string name = 2;
Span span = 3;
string change = 4;
}
message ParseError {
string error = 1;
Span span = 2;
string language = 3;
}
message HealthCheckRequest {
string service = 1;
}
message HealthCheckResponse {
enum ServingStatus {
UNKNOWN = 0;
SERVING = 1;
NOT_SERVING = 2;
}
ServingStatus status = 1;
}