Skip to content

Latest commit

 

History

History
221 lines (114 loc) · 10.3 KB

ENDPOINTS.md

File metadata and controls

221 lines (114 loc) · 10.3 KB
Raw

Protocol Documentation

Table of Contents

Top

content/consumer/v1/consumer.proto

CreateCompileRequest

The request to compile and run code.

Field Type Label Description
language string The target language that is being sent. Incorrectly setting this will result in a faulted request.
source string The source code that will be executed, this should be well formatted as if it was ready to be compiled. Misconfigured ro formatted code will be rejected by the runtime or compiler.
standard_in_data string repeated This array of strings will be written to the standard input of the code when executing. Each array item is a line which will be written one after another.
expected_standard_out_data string repeated This is an array of expected output data, including data here that will result in a validation check on completion. If no items are added to the array then the status endpoint will return NoTest for the test status. Otherwise, a value related to the test result.

CreateCompileResponse

The response when requesting a compiled request via the queue.

Field Type Label Description
id string The reference ID of the compile request. Use later to retrieve updated information regarding the state of the execution.

GetCompileResultRequest

Compile result request can be used to request updated information about the state or result of the compile request.

Field Type Label Description
id string The id of the request, this value would have been returned by the compile execution request.

GetCompileResultResponse

The details of a compile request.

Field Type Label Description
language string The language which was used in to compile and execute request. This will match the request language.
status string The resulting status of the entire request.
test_status string The resulting test status, if a test was provided.
compile_ms int64 The total milliseconds taken to compile the request if it was not an interpreted language.
runtime_ms int64 The total milliseconds taken to run the code.
runtime_memory_mb double The maximum number of megabytes used to run the request.
output string The raw output of the request.
output_error string The raw error output of the request.
compiler_output string The raw compile output of the request, if compiled.

GetSupportedLanguagesResponse

Contains the list of supported languages currently.

Field Type Label Description
languages SupportedLanguage repeated The list of supported languages within the system.

GetTemplateRequest

Used to request a usable code snippet/template for a given supported language.

Field Type Label Description
language string The language which template should be returned.

GetTemplateResponse

Returns the template code for a given language. This template can compile and run safely out of the box.

Field Type Label Description
template string The template code for the given requested language.

PingResponse

The response from the ping.

Field Type Label Description
message string The ping message.

SupportedLanguage

A possible supported language information.

Field Type Label Description
language_code string The language code send during the compile request, this is not the same as the display name. This is also the code used to get the template.
display_name string The display name the user can be shown and will understand for example the display name could be C# and the code would be csharp.

ConsumerService

The main consumer service to communicate with cars.

Method Name Request Type Response Type Description
Ping .google.protobuf.Empty PingResponse Ping is used by internal services to ensure the service is running.
GetTemplate GetTemplateRequest GetTemplateResponse GetTemplate is designed to allow consumers of the platform to serve the user with a template they can start from. This is more important for languages that require selective formatting or a main function. An example of these languages would be C++, and C.
GetSupportedLanguages .google.protobuf.Empty GetSupportedLanguagesResponse GetSupportedLanguages will return a list of languages that can be exposed to the user. This response contains a display name for the language that will contain compiler information if important and will also return the code. The code is the value sent to the server when requesting to compile and run.
CreateCompile CreateCompileRequest CreateCompileResponse CompileQueueRequest is the core compile request endpoint. Calling into this will trigger the flow to run the user-submitted code.
GetCompileResult GetCompileResultRequest GetCompileResultResponse GetCompileResultRequest is required to be called after requesting to compile, all details about the running state and the final output of the compiling and execution are from this.

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)