File size: 3,335 Bytes
5d3c01b | 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 | syntax = "proto3";
package sebuf.http;
import "google/protobuf/descriptor.proto";
option go_package = "github.com/SebastienMelki/sebuf/http;http";
// HttpMethod specifies the HTTP verb for an RPC method
enum HttpMethod {
// Unspecified defaults to POST for backward compatibility
HTTP_METHOD_UNSPECIFIED = 0;
HTTP_METHOD_GET = 1;
HTTP_METHOD_POST = 2;
HTTP_METHOD_PUT = 3;
HTTP_METHOD_DELETE = 4;
HTTP_METHOD_PATCH = 5;
}
// HttpConfig defines HTTP-specific configuration for an RPC method
message HttpConfig {
// The HTTP path for this method (supports path variables like /users/{id})
string path = 1;
// The HTTP method (GET, POST, PUT, DELETE, PATCH). Defaults to POST if unspecified.
HttpMethod method = 2;
}
// Extension for method options
extend google.protobuf.MethodOptions {
HttpConfig config = 50003;
}
// ServiceConfig defines HTTP-specific configuration for an entire service
message ServiceConfig {
// Base path prefix for all methods in this service
string base_path = 1;
}
// Extension for service options
extend google.protobuf.ServiceOptions {
ServiceConfig service_config = 50004;
}
// FieldExamples defines example values for a field
message FieldExamples {
// List of example values for this field
repeated string values = 1;
}
// QueryConfig defines query parameter configuration for a message field
message QueryConfig {
// The query parameter name in the URL (e.g., "page_size" for ?page_size=10)
string name = 1;
// Whether this query parameter is required
bool required = 2;
}
// Int64Encoding specifies how int64 fields should be encoded in generated TypeScript.
// By default, int64 fields generate as `string` for JSON safety. When set to
// INT64_ENCODING_NUMBER, the field generates as `number` instead -- suitable for
// values that fit within Number.MAX_SAFE_INTEGER (e.g., Unix epoch milliseconds).
enum Int64Encoding {
// Unspecified -- use default behavior (string).
INT64_ENCODING_UNSPECIFIED = 0;
// Encode as string (default JSON behavior for int64).
INT64_ENCODING_STRING = 1;
// Encode as number -- only use for values within Number.MAX_SAFE_INTEGER.
INT64_ENCODING_NUMBER = 2;
}
// Extension for field-level options
extend google.protobuf.FieldOptions {
// Example values for documentation/OpenAPI
FieldExamples field_examples = 50007;
// Query parameter configuration for a field
QueryConfig query = 50008;
// Mark a repeated field for unwrapping when parent message is a map value.
// When set to true on a repeated field, and the message containing this field
// is used as a map value, the JSON serialization will collapse the wrapper
// to just the unwrapped field's array value.
// Constraints: Only valid on repeated fields, only one per message.
bool unwrap = 50009;
// Specify how an int64 field should be encoded in generated TypeScript code.
// Use INT64_ENCODING_NUMBER for timestamp fields (Unix epoch milliseconds)
// that safely fit within JavaScript's Number.MAX_SAFE_INTEGER.
Int64Encoding int64_encoding = 50010;
// Marks a declared HTTP query field as accepted by the API surface but not
// currently implemented by the handler. Field comments must disclose the
// accepted-but-ignored/no-op behavior so generated OpenAPI stays honest.
bool unimplemented = 50011;
}
|