109 lines
3.3 KiB
Protocol Buffer
109 lines
3.3 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
package officeconvertapi.v1;
|
|
|
|
import "google/protobuf/timestamp.proto";
|
|
|
|
option go_package = "github.com/end/officeconvert/gen/go/officeconvertapi/v1;officeconvertapiv1";
|
|
|
|
// ConversionService orchestrates presentation conversion jobs.
|
|
service ConversionService {
|
|
// CreateConversion allocates a short-lived session and upload URL for a PPTX.
|
|
rpc CreateConversion(CreateConversionRequest) returns (CreateConversionResponse) {}
|
|
|
|
// StartConversion marks upload completion and starts server-side conversion.
|
|
rpc StartConversion(StartConversionRequest) returns (StartConversionResponse) {}
|
|
|
|
// GetConversionStatus returns state transitions for a conversion session.
|
|
rpc GetConversionStatus(GetConversionStatusRequest) returns (GetConversionStatusResponse) {}
|
|
|
|
// GetSlideDeck fetches the final slide deck data after successful conversion.
|
|
rpc GetSlideDeck(GetSlideDeckRequest) returns (GetSlideDeckResponse) {}
|
|
|
|
// DeleteConversion deletes session resources before automatic expiration.
|
|
rpc DeleteConversion(DeleteConversionRequest) returns (DeleteConversionResponse) {}
|
|
}
|
|
|
|
// ConversionStatus represents the lifecycle state of a conversion request.
|
|
enum ConversionStatus {
|
|
CONVERSION_STATUS_UNSPECIFIED = 0;
|
|
CONVERSION_STATUS_PENDING = 1;
|
|
CONVERSION_STATUS_RUNNING = 2;
|
|
CONVERSION_STATUS_SUCCEEDED = 3;
|
|
CONVERSION_STATUS_FAILED = 4;
|
|
}
|
|
|
|
// Slide contains extracted notes and the rendered image URL for one slide.
|
|
message Slide {
|
|
int32 index = 1;
|
|
string notes_plain = 2;
|
|
string image_url = 3;
|
|
}
|
|
|
|
// SlideDeck is the final structured conversion artifact.
|
|
message SlideDeck {
|
|
string conversion_id = 1;
|
|
string source_filename = 2;
|
|
repeated Slide slides = 3;
|
|
google.protobuf.Timestamp created_at = 4;
|
|
}
|
|
|
|
// CreateConversionRequest starts a conversion session.
|
|
message CreateConversionRequest {
|
|
string source_filename = 1;
|
|
}
|
|
|
|
// CreateConversionResponse returns upload details for the session.
|
|
message CreateConversionResponse {
|
|
string conversion_id = 1;
|
|
string upload_bucket = 2;
|
|
string upload_object_key = 3;
|
|
string upload_url = 4;
|
|
google.protobuf.Timestamp expires_at = 5;
|
|
}
|
|
|
|
// StartConversionRequest requests conversion of an already uploaded PPTX.
|
|
message StartConversionRequest {
|
|
string conversion_id = 1;
|
|
}
|
|
|
|
// StartConversionResponse returns the first known status after enqueue.
|
|
message StartConversionResponse {
|
|
string conversion_id = 1;
|
|
ConversionStatus status = 2;
|
|
}
|
|
|
|
// GetConversionStatusRequest asks for a specific conversion status.
|
|
message GetConversionStatusRequest {
|
|
string conversion_id = 1;
|
|
}
|
|
|
|
// GetConversionStatusResponse returns current status and optional error info.
|
|
message GetConversionStatusResponse {
|
|
string conversion_id = 1;
|
|
ConversionStatus status = 2;
|
|
string error_message = 3;
|
|
google.protobuf.Timestamp updated_at = 4;
|
|
}
|
|
|
|
// GetSlideDeckRequest fetches a completed deck.
|
|
message GetSlideDeckRequest {
|
|
string conversion_id = 1;
|
|
}
|
|
|
|
// GetSlideDeckResponse contains the converted slide deck.
|
|
message GetSlideDeckResponse {
|
|
SlideDeck slide_deck = 1;
|
|
}
|
|
|
|
// DeleteConversionRequest requests immediate cleanup.
|
|
message DeleteConversionRequest {
|
|
string conversion_id = 1;
|
|
}
|
|
|
|
// DeleteConversionResponse confirms cleanup details.
|
|
message DeleteConversionResponse {
|
|
string conversion_id = 1;
|
|
bool deleted = 2;
|
|
}
|