diff --git a/src/BackOffice.BFF.Application/BackOffice.BFF.Application.csproj b/src/BackOffice.BFF.Application/BackOffice.BFF.Application.csproj
index b294a18..aae3c96 100644
--- a/src/BackOffice.BFF.Application/BackOffice.BFF.Application.csproj
+++ b/src/BackOffice.BFF.Application/BackOffice.BFF.Application.csproj
@@ -7,7 +7,7 @@
-
+
diff --git a/src/BackOffice.BFF.Application/CategoryCQ/Commands/CreateNewCategory/CreateNewCategoryCommand.cs b/src/BackOffice.BFF.Application/CategoryCQ/Commands/CreateNewCategory/CreateNewCategoryCommand.cs
new file mode 100644
index 0000000..61061a9
--- /dev/null
+++ b/src/BackOffice.BFF.Application/CategoryCQ/Commands/CreateNewCategory/CreateNewCategoryCommand.cs
@@ -0,0 +1,13 @@
+namespace BackOffice.BFF.Application.CategoryCQ.Commands.CreateNewCategory;
+
+public record CreateNewCategoryCommand : IRequest
+{
+ public string Name { get; init; } = string.Empty;
+ public string Title { get; init; } = string.Empty;
+ public string? Description { get; init; }
+ public string? ImagePath { get; init; }
+ public long? ParentId { get; init; }
+ public bool IsActive { get; init; }
+ public int SortOrder { get; init; }
+}
+
diff --git a/src/BackOffice.BFF.Application/CategoryCQ/Commands/CreateNewCategory/CreateNewCategoryCommandHandler.cs b/src/BackOffice.BFF.Application/CategoryCQ/Commands/CreateNewCategory/CreateNewCategoryCommandHandler.cs
new file mode 100644
index 0000000..c0e0134
--- /dev/null
+++ b/src/BackOffice.BFF.Application/CategoryCQ/Commands/CreateNewCategory/CreateNewCategoryCommandHandler.cs
@@ -0,0 +1,22 @@
+using BackOffice.BFF.Application.Common.Interfaces;
+using CMSCategory = CMSMicroservice.Protobuf.Protos.Category;
+
+namespace BackOffice.BFF.Application.CategoryCQ.Commands.CreateNewCategory;
+
+public class CreateNewCategoryCommandHandler : IRequestHandler
+{
+ private readonly IApplicationContractContext _context;
+
+ public CreateNewCategoryCommandHandler(IApplicationContractContext context)
+ {
+ _context = context;
+ }
+
+ public async Task Handle(CreateNewCategoryCommand request, CancellationToken cancellationToken)
+ {
+ var cmsRequest = request.Adapt();
+ var response = await _context.Categories.CreateNewCategoryAsync(cmsRequest, cancellationToken: cancellationToken);
+ return response.Adapt();
+ }
+}
+
diff --git a/src/BackOffice.BFF.Application/CategoryCQ/Commands/CreateNewCategory/CreateNewCategoryCommandValidator.cs b/src/BackOffice.BFF.Application/CategoryCQ/Commands/CreateNewCategory/CreateNewCategoryCommandValidator.cs
new file mode 100644
index 0000000..98bed90
--- /dev/null
+++ b/src/BackOffice.BFF.Application/CategoryCQ/Commands/CreateNewCategory/CreateNewCategoryCommandValidator.cs
@@ -0,0 +1,24 @@
+namespace BackOffice.BFF.Application.CategoryCQ.Commands.CreateNewCategory;
+
+public class CreateNewCategoryCommandValidator : AbstractValidator
+{
+ public CreateNewCategoryCommandValidator()
+ {
+ RuleFor(x => x.Name).NotEmpty();
+ RuleFor(x => x.Title).NotEmpty();
+ }
+
+ public Func
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
diff --git a/src/BackOffice.BFF.WebApi/Services/CategoryService.cs b/src/BackOffice.BFF.WebApi/Services/CategoryService.cs
new file mode 100644
index 0000000..6623fdb
--- /dev/null
+++ b/src/BackOffice.BFF.WebApi/Services/CategoryService.cs
@@ -0,0 +1,45 @@
+using BackOffice.BFF.Category.Protobuf.Protos.Category;
+using BackOffice.BFF.WebApi.Common.Services;
+using BackOffice.BFF.Application.CategoryCQ.Commands.CreateNewCategory;
+using BackOffice.BFF.Application.CategoryCQ.Commands.UpdateCategory;
+using BackOffice.BFF.Application.CategoryCQ.Commands.DeleteCategory;
+using BackOffice.BFF.Application.CategoryCQ.Queries.GetCategory;
+using BackOffice.BFF.Application.CategoryCQ.Queries.GetAllCategoryByFilter;
+
+namespace BackOffice.BFF.WebApi.Services;
+
+public class CategoryService : CategoryContract.CategoryContractBase
+{
+ private readonly IDispatchRequestToCQRS _dispatchRequestToCQRS;
+
+ public CategoryService(IDispatchRequestToCQRS dispatchRequestToCQRS)
+ {
+ _dispatchRequestToCQRS = dispatchRequestToCQRS;
+ }
+
+ public override async Task CreateNewCategory(CreateNewCategoryRequest request, ServerCallContext context)
+ {
+ return await _dispatchRequestToCQRS.Handle(request, context);
+ }
+
+ public override async Task UpdateCategory(UpdateCategoryRequest request, ServerCallContext context)
+ {
+ return await _dispatchRequestToCQRS.Handle(request, context);
+ }
+
+ public override async Task DeleteCategory(DeleteCategoryRequest request, ServerCallContext context)
+ {
+ return await _dispatchRequestToCQRS.Handle(request, context);
+ }
+
+ public override async Task GetCategory(GetCategoryRequest request, ServerCallContext context)
+ {
+ return await _dispatchRequestToCQRS.Handle(request, context);
+ }
+
+ public override async Task GetAllCategoryByFilter(GetAllCategoryByFilterRequest request, ServerCallContext context)
+ {
+ return await _dispatchRequestToCQRS.Handle(request, context);
+ }
+}
+
diff --git a/src/BackOffice.BFF.sln b/src/BackOffice.BFF.sln
index 66b437d..61b587c 100644
--- a/src/BackOffice.BFF.sln
+++ b/src/BackOffice.BFF.sln
@@ -28,6 +28,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BackOffice.BFF.Otp.Protobuf
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BackOffice.BFF.Products.Protobuf", "Protobufs\BackOffice.BFF.Products.Protobuf\BackOffice.BFF.Products.Protobuf.csproj", "{DFDECBE8-D071-4CDB-A1B4-D5C556EF72A6}"
EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BackOffice.BFF.Category.Protobuf", "Protobufs\BackOffice.BFF.Category.Protobuf\BackOffice.BFF.Category.Protobuf.csproj", "{640BD51E-8298-4074-9713-BCE619318155}"
+EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
@@ -82,6 +84,10 @@ Global
{DFDECBE8-D071-4CDB-A1B4-D5C556EF72A6}.Debug|Any CPU.Build.0 = Debug|Any CPU
{DFDECBE8-D071-4CDB-A1B4-D5C556EF72A6}.Release|Any CPU.ActiveCfg = Release|Any CPU
{DFDECBE8-D071-4CDB-A1B4-D5C556EF72A6}.Release|Any CPU.Build.0 = Release|Any CPU
+ {640BD51E-8298-4074-9713-BCE619318155}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {640BD51E-8298-4074-9713-BCE619318155}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {640BD51E-8298-4074-9713-BCE619318155}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {640BD51E-8298-4074-9713-BCE619318155}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
@@ -95,6 +101,7 @@ Global
{CB811954-E42E-75BB-A02D-689180B72E28} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
{E1833EDA-39E9-C241-2772-E4C7E960AC41} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
{DFDECBE8-D071-4CDB-A1B4-D5C556EF72A6} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
+ {640BD51E-8298-4074-9713-BCE619318155} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {0AE1AB4A-3C91-4853-93C2-C2476E79F845}
diff --git a/src/Protobufs/BackOffice.BFF.Category.Protobuf/BackOffice.BFF.Category.Protobuf.csproj b/src/Protobufs/BackOffice.BFF.Category.Protobuf/BackOffice.BFF.Category.Protobuf.csproj
new file mode 100644
index 0000000..0e80d4c
--- /dev/null
+++ b/src/Protobufs/BackOffice.BFF.Category.Protobuf/BackOffice.BFF.Category.Protobuf.csproj
@@ -0,0 +1,42 @@
+
+
+
+ net9.0
+ enable
+ enable
+ 0.0.1
+ None
+ False
+ False
+ Foursat.BackOffice.BFF.Category.Protobuf
+
+
+
+
+
+
+
+ runtime; build; native; contentfiles; analyzers; buildtransitive
+ all
+
+
+
+
+
+
+
+
+
+
+
+ $(PackageOutputPath)$(PackageId).$(Version).nupkg
+
+ dotnet nuget push **/*.nupkg --source https://git.afrino.co/api/packages/FourSat/nuget/index.json --api-key 061a5cb15517c6da39c16cfce8556c55ae104d0d --skip-duplicate
+
+
+
+
+
+
+
+
diff --git a/src/Protobufs/BackOffice.BFF.Category.Protobuf/ConfigureServices.cs b/src/Protobufs/BackOffice.BFF.Category.Protobuf/ConfigureServices.cs
new file mode 100644
index 0000000..3f0ca92
--- /dev/null
+++ b/src/Protobufs/BackOffice.BFF.Category.Protobuf/ConfigureServices.cs
@@ -0,0 +1,14 @@
+using FluentValidation;
+using System.Reflection;
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+public static class ConfigureServices
+{
+ public static IServiceCollection AddCategoryProtobufServices(this IServiceCollection services)
+ {
+ services.AddValidatorsFromAssembly(Assembly.GetExecutingAssembly());
+ return services;
+ }
+}
+
diff --git a/src/Protobufs/BackOffice.BFF.Category.Protobuf/Protos/category.proto b/src/Protobufs/BackOffice.BFF.Category.Protobuf/Protos/category.proto
new file mode 100644
index 0000000..f93e26a
--- /dev/null
+++ b/src/Protobufs/BackOffice.BFF.Category.Protobuf/Protos/category.proto
@@ -0,0 +1,147 @@
+syntax = "proto3";
+
+package category;
+
+import "google/protobuf/empty.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+import "google/api/annotations.proto";
+
+option csharp_namespace = "BackOffice.BFF.Category.Protobuf.Protos.Category";
+
+service CategoryContract
+{
+ rpc CreateNewCategory(CreateNewCategoryRequest) returns (CreateNewCategoryResponse){
+ option (google.api.http) = {
+ post: "/CreateNewCategory"
+ body: "*"
+ };
+ };
+ rpc UpdateCategory(UpdateCategoryRequest) returns (google.protobuf.Empty){
+ option (google.api.http) = {
+ put: "/UpdateCategory"
+ body: "*"
+ };
+ };
+ rpc DeleteCategory(DeleteCategoryRequest) returns (google.protobuf.Empty){
+ option (google.api.http) = {
+ delete: "/DeleteCategory"
+ body: "*"
+ };
+ };
+ rpc GetCategory(GetCategoryRequest) returns (GetCategoryResponse){
+ option (google.api.http) = {
+ get: "/GetCategory"
+ };
+ };
+ rpc GetAllCategoryByFilter(GetAllCategoryByFilterRequest) returns (GetAllCategoryByFilterResponse){
+ option (google.api.http) = {
+ get: "/GetAllCategoryByFilter"
+ };
+ };
+}
+
+message CreateNewCategoryRequest
+{
+ string name = 1;
+ string title = 2;
+ google.protobuf.StringValue description = 3;
+ google.protobuf.StringValue image_path = 4;
+ google.protobuf.Int64Value parent_id = 5;
+ bool is_active = 6;
+ int32 sort_order = 7;
+}
+
+message CreateNewCategoryResponse
+{
+ int64 id = 1;
+}
+
+message UpdateCategoryRequest
+{
+ int64 id = 1;
+ string name = 2;
+ string title = 3;
+ google.protobuf.StringValue description = 4;
+ google.protobuf.StringValue image_path = 5;
+ google.protobuf.Int64Value parent_id = 6;
+ bool is_active = 7;
+ int32 sort_order = 8;
+}
+
+message DeleteCategoryRequest
+{
+ int64 id = 1;
+}
+
+message GetCategoryRequest
+{
+ int64 id = 1;
+}
+
+message GetCategoryResponse
+{
+ int64 id = 1;
+ string name = 2;
+ string title = 3;
+ google.protobuf.StringValue description = 4;
+ google.protobuf.StringValue image_path = 5;
+ google.protobuf.Int64Value parent_id = 6;
+ bool is_active = 7;
+ int32 sort_order = 8;
+}
+
+message GetAllCategoryByFilterRequest
+{
+ PaginationState pagination_state = 1;
+ google.protobuf.StringValue sort_by = 2;
+ GetAllCategoryByFilterFilter filter = 3;
+}
+
+message GetAllCategoryByFilterFilter
+{
+ google.protobuf.Int64Value id = 1;
+ google.protobuf.StringValue name = 2;
+ google.protobuf.StringValue title = 3;
+ google.protobuf.StringValue description = 4;
+ google.protobuf.StringValue image_path = 5;
+ google.protobuf.Int64Value parent_id = 6;
+ google.protobuf.BoolValue is_active = 7;
+ google.protobuf.Int32Value sort_order = 8;
+}
+
+message GetAllCategoryByFilterResponse
+{
+ MetaData meta_data = 1;
+ repeated GetAllCategoryByFilterResponseModel models = 2;
+}
+
+message GetAllCategoryByFilterResponseModel
+{
+ int64 id = 1;
+ string name = 2;
+ string title = 3;
+ google.protobuf.StringValue description = 4;
+ google.protobuf.StringValue image_path = 5;
+ google.protobuf.Int64Value parent_id = 6;
+ bool is_active = 7;
+ int32 sort_order = 8;
+}
+
+message PaginationState
+{
+ int32 page_number = 1;
+ int32 page_size = 2;
+}
+
+message MetaData
+{
+ int64 current_page = 1;
+ int64 total_page = 2;
+ int64 page_size = 3;
+ int64 total_count = 4;
+ bool has_previous = 5;
+ bool has_next = 6;
+}
+
diff --git a/src/Protobufs/BackOffice.BFF.Category.Protobuf/Protos/google/api/annotations.proto b/src/Protobufs/BackOffice.BFF.Category.Protobuf/Protos/google/api/annotations.proto
new file mode 100644
index 0000000..85c361b
--- /dev/null
+++ b/src/Protobufs/BackOffice.BFF.Category.Protobuf/Protos/google/api/annotations.proto
@@ -0,0 +1,31 @@
+// Copyright (c) 2015, Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api;
+
+import "google/api/http.proto";
+import "google/protobuf/descriptor.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
+option java_multiple_files = true;
+option java_outer_classname = "AnnotationsProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+extend google.protobuf.MethodOptions {
+ // See `HttpRule`.
+ HttpRule http = 72295728;
+}
diff --git a/src/Protobufs/BackOffice.BFF.Category.Protobuf/Protos/google/api/http.proto b/src/Protobufs/BackOffice.BFF.Category.Protobuf/Protos/google/api/http.proto
new file mode 100644
index 0000000..b8426ba
--- /dev/null
+++ b/src/Protobufs/BackOffice.BFF.Category.Protobuf/Protos/google/api/http.proto
@@ -0,0 +1,377 @@
+// Copyright 2019 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+syntax = "proto3";
+
+package google.api;
+
+option cc_enable_arenas = true;
+option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
+option java_multiple_files = true;
+option java_outer_classname = "HttpProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+// Defines the HTTP configuration for an API service. It contains a list of
+// [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method
+// to one or more HTTP REST API methods.
+message Http {
+ // A list of HTTP configuration rules that apply to individual API methods.
+ //
+ // **NOTE:** All service configuration rules follow "last one wins" order.
+ repeated HttpRule rules = 1;
+
+ // When set to true, URL path parameters will be fully URI-decoded except in
+ // cases of single segment matches in reserved expansion, where "%2F" will be
+ // left encoded.
+ //
+ // The default behavior is to not decode RFC 6570 reserved characters in multi
+ // segment matches.
+ bool fully_decode_reserved_expansion = 2;
+}
+
+// # gRPC Transcoding
+//
+// gRPC Transcoding is a feature for mapping between a gRPC method and one or
+// more HTTP REST endpoints. It allows developers to build a single API service
+// that supports both gRPC APIs and REST APIs. Many systems, including [Google
+// APIs](https://github.com/googleapis/googleapis),
+// [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
+// Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
+// and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
+// and use it for large scale production services.
+//
+// `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
+// how different portions of the gRPC request message are mapped to the URL
+// path, URL query parameters, and HTTP request body. It also controls how the
+// gRPC response message is mapped to the HTTP response body. `HttpRule` is
+// typically specified as an `google.api.http` annotation on the gRPC method.
+//
+// Each mapping specifies a URL path template and an HTTP method. The path
+// template may refer to one or more fields in the gRPC request message, as long
+// as each field is a non-repeated field with a primitive (non-message) type.
+// The path template controls how fields of the request message are mapped to
+// the URL path.
+//
+// Example:
+//
+// service Messaging {
+// rpc GetMessage(GetMessageRequest) returns (Message) {
+// option (google.api.http) = {
+// get: "/v1/{name=messages/*}"
+// };
+// }
+// }
+// message GetMessageRequest {
+// string name = 1; // Mapped to URL path.
+// }
+// message Message {
+// string text = 1; // The resource content.
+// }
+//
+// This enables an HTTP REST to gRPC mapping as below:
+//
+// HTTP | gRPC
+// -----|-----
+// `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
+//
+// Any fields in the request message which are not bound by the path template
+// automatically become HTTP query parameters if there is no HTTP request body.
+// For example:
+//
+// service Messaging {
+// rpc GetMessage(GetMessageRequest) returns (Message) {
+// option (google.api.http) = {
+// get:"/v1/messages/{message_id}"
+// };
+// }
+// }
+// message GetMessageRequest {
+// message SubMessage {
+// string subfield = 1;
+// }
+// string message_id = 1; // Mapped to URL path.
+// int64 revision = 2; // Mapped to URL query parameter `revision`.
+// SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
+// }
+//
+// This enables a HTTP JSON to RPC mapping as below:
+//
+// HTTP | gRPC
+// -----|-----
+// `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
+// `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
+// "foo"))`
+//
+// Note that fields which are mapped to URL query parameters must have a
+// primitive type or a repeated primitive type or a non-repeated message type.
+// In the case of a repeated type, the parameter can be repeated in the URL
+// as `...?param=A¶m=B`. In the case of a message type, each field of the
+// message is mapped to a separate parameter, such as
+// `...?foo.a=A&foo.b=B&foo.c=C`.
+//
+// For HTTP methods that allow a request body, the `body` field
+// specifies the mapping. Consider a REST update method on the
+// message resource collection:
+//
+// service Messaging {
+// rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
+// option (google.api.http) = {
+// patch: "/v1/messages/{message_id}"
+// body: "message"
+// };
+// }
+// }
+// message UpdateMessageRequest {
+// string message_id = 1; // mapped to the URL
+// Message message = 2; // mapped to the body
+// }
+//
+// The following HTTP JSON to RPC mapping is enabled, where the
+// representation of the JSON in the request body is determined by
+// protos JSON encoding:
+//
+// HTTP | gRPC
+// -----|-----
+// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
+// "123456" message { text: "Hi!" })`
+//
+// The special name `*` can be used in the body mapping to define that
+// every field not bound by the path template should be mapped to the
+// request body. This enables the following alternative definition of
+// the update method:
+//
+// service Messaging {
+// rpc UpdateMessage(Message) returns (Message) {
+// option (google.api.http) = {
+// patch: "/v1/messages/{message_id}"
+// body: "*"
+// };
+// }
+// }
+// message Message {
+// string message_id = 1;
+// string text = 2;
+// }
+//
+//
+// The following HTTP JSON to RPC mapping is enabled:
+//
+// HTTP | gRPC
+// -----|-----
+// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
+// "123456" text: "Hi!")`
+//
+// Note that when using `*` in the body mapping, it is not possible to
+// have HTTP parameters, as all fields not bound by the path end in
+// the body. This makes this option more rarely used in practice when
+// defining REST APIs. The common usage of `*` is in custom methods
+// which don't use the URL at all for transferring data.
+//
+// It is possible to define multiple HTTP methods for one RPC by using
+// the `additional_bindings` option. Example:
+//
+// service Messaging {
+// rpc GetMessage(GetMessageRequest) returns (Message) {
+// option (google.api.http) = {
+// get: "/v1/messages/{message_id}"
+// additional_bindings {
+// get: "/v1/users/{user_id}/messages/{message_id}"
+// }
+// };
+// }
+// }
+// message GetMessageRequest {
+// string message_id = 1;
+// string user_id = 2;
+// }
+//
+// This enables the following two alternative HTTP JSON to RPC mappings:
+//
+// HTTP | gRPC
+// -----|-----
+// `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
+// `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
+// "123456")`
+//
+// ## Rules for HTTP mapping
+//
+// 1. Leaf request fields (recursive expansion nested messages in the request
+// message) are classified into three categories:
+// - Fields referred by the path template. They are passed via the URL path.
+// - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP
+// request body.
+// - All other fields are passed via the URL query parameters, and the
+// parameter name is the field path in the request message. A repeated
+// field can be represented as multiple query parameters under the same
+// name.
+// 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields
+// are passed via URL path and HTTP request body.
+// 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all
+// fields are passed via URL path and URL query parameters.
+//
+// ### Path template syntax
+//
+// Template = "/" Segments [ Verb ] ;
+// Segments = Segment { "/" Segment } ;
+// Segment = "*" | "**" | LITERAL | Variable ;
+// Variable = "{" FieldPath [ "=" Segments ] "}" ;
+// FieldPath = IDENT { "." IDENT } ;
+// Verb = ":" LITERAL ;
+//
+// The syntax `*` matches a single URL path segment. The syntax `**` matches
+// zero or more URL path segments, which must be the last part of the URL path
+// except the `Verb`.
+//
+// The syntax `Variable` matches part of the URL path as specified by its
+// template. A variable template must not contain other variables. If a variable
+// matches a single path segment, its template may be omitted, e.g. `{var}`
+// is equivalent to `{var=*}`.
+//
+// The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
+// contains any reserved character, such characters should be percent-encoded
+// before the matching.
+//
+// If a variable contains exactly one path segment, such as `"{var}"` or
+// `"{var=*}"`, when such a variable is expanded into a URL path on the client
+// side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
+// server side does the reverse decoding. Such variables show up in the
+// [Discovery
+// Document](https://developers.google.com/discovery/v1/reference/apis) as
+// `{var}`.
+//
+// If a variable contains multiple path segments, such as `"{var=foo/*}"`
+// or `"{var=**}"`, when such a variable is expanded into a URL path on the
+// client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
+// The server side does the reverse decoding, except "%2F" and "%2f" are left
+// unchanged. Such variables show up in the
+// [Discovery
+// Document](https://developers.google.com/discovery/v1/reference/apis) as
+// `{+var}`.
+//
+// ## Using gRPC API Service Configuration
+//
+// gRPC API Service Configuration (service config) is a configuration language
+// for configuring a gRPC service to become a user-facing product. The
+// service config is simply the YAML representation of the `google.api.Service`
+// proto message.
+//
+// As an alternative to annotating your proto file, you can configure gRPC
+// transcoding in your service config YAML files. You do this by specifying a
+// `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
+// effect as the proto annotation. This can be particularly useful if you
+// have a proto that is reused in multiple services. Note that any transcoding
+// specified in the service config will override any matching transcoding
+// configuration in the proto.
+//
+// Example:
+//
+// http:
+// rules:
+// # Selects a gRPC method and applies HttpRule to it.
+// - selector: example.v1.Messaging.GetMessage
+// get: /v1/messages/{message_id}/{sub.subfield}
+//
+// ## Special notes
+//
+// When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
+// proto to JSON conversion must follow the [proto3
+// specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
+//
+// While the single segment variable follows the semantics of
+// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
+// Expansion, the multi segment variable **does not** follow RFC 6570 Section
+// 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
+// does not expand special characters like `?` and `#`, which would lead
+// to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
+// for multi segment variables.
+//
+// The path variables **must not** refer to any repeated or mapped field,
+// because client libraries are not capable of handling such variable expansion.
+//
+// The path variables **must not** capture the leading "/" character. The reason
+// is that the most common use case "{var}" does not capture the leading "/"
+// character. For consistency, all path variables must share the same behavior.
+//
+// Repeated message fields must not be mapped to URL query parameters, because
+// no client library can support such complicated mapping.
+//
+// If an API needs to use a JSON array for request or response body, it can map
+// the request or response body to a repeated field. However, some gRPC
+// Transcoding implementations may not support this feature.
+message HttpRule {
+ // Selects a method to which this rule applies.
+ //
+ // Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
+ string selector = 1;
+
+ // Determines the URL pattern is matched by this rules. This pattern can be
+ // used with any of the {get|put|post|delete|patch} methods. A custom method
+ // can be defined using the 'custom' field.
+ oneof pattern {
+ // Maps to HTTP GET. Used for listing and getting information about
+ // resources.
+ string get = 2;
+
+ // Maps to HTTP PUT. Used for replacing a resource.
+ string put = 3;
+
+ // Maps to HTTP POST. Used for creating a resource or performing an action.
+ string post = 4;
+
+ // Maps to HTTP DELETE. Used for deleting a resource.
+ string delete = 5;
+
+ // Maps to HTTP PATCH. Used for updating a resource.
+ string patch = 6;
+
+ // The custom pattern is used for specifying an HTTP method that is not
+ // included in the `pattern` field, such as HEAD, or "*" to leave the
+ // HTTP method unspecified for this rule. The wild-card rule is useful
+ // for services that provide content to Web (HTML) clients.
+ CustomHttpPattern custom = 8;
+ }
+
+ // The name of the request field whose value is mapped to the HTTP request
+ // body, or `*` for mapping all request fields not captured by the path
+ // pattern to the HTTP body, or omitted for not having any HTTP request body.
+ //
+ // NOTE: the referred field must be present at the top-level of the request
+ // message type.
+ string body = 7;
+
+ // Optional. The name of the response field whose value is mapped to the HTTP
+ // response body. When omitted, the entire response message will be used
+ // as the HTTP response body.
+ //
+ // NOTE: The referred field must be present at the top-level of the response
+ // message type.
+ string response_body = 12;
+
+ // Additional HTTP bindings for the selector. Nested bindings must
+ // not contain an `additional_bindings` field themselves (that is,
+ // the nesting may only be one level deep).
+ repeated HttpRule additional_bindings = 11;
+}
+
+// A custom pattern is used for defining custom HTTP verb.
+message CustomHttpPattern {
+ // The name of this custom HTTP verb.
+ string kind = 1;
+
+ // The path matched by this custom verb.
+ string path = 2;
+}
+