Merge pull request #600 from mulesoft/W-21311839-Add-gRPC-to-ACB-docs-CP

W-21311839-Add-gRPC-to-ACB-docs-CP

Author: Crispy-Salesforce

modules/ROOT/nav.adoc

@@ -71,8 +71,10 @@
 * xref:des-designing-api-specs.adoc[]
 ** xref:des-create-api-specs.adoc[]
 ** xref:des-create-asyncapi-api-specs.adoc[]
+** xref:des-design-grpc-api-spec.adoc[]
 ** xref:des-create-api-fragments.adoc[]
 ** xref:des-publish-api-spec-to-exchange.adoc[]
+** xref:des-publish-grpc-api-to-exchange.adoc[]
 ** xref:des-govern-api.adoc[]
 ** xref:des-delete-api-projects.adoc[]
 
@@ -102,6 +104,7 @@
 * xref:imp-implementing-apis.adoc[]
 ** xref:imp-implement-api-specs.adoc[]
 ** xref:imp-asyncapi.adoc[]
+** xref:imp-implement-grpc-api-spec.adoc[]
 ** xref:imp-implement-local-apis.adoc[]
 ** xref:imp-filter-search-results.adoc[]
 

modules/ROOT/pages/_partials/acb-component-info.adoc

@@ -97,11 +97,11 @@ To find information about more connectors, see xref:connectors::introduction/int
 
 Use the Connection Management Configuration Panel to easily configure connections to third-party systems directly from the UI. 
 
-In this panel, you can create, edit, delete, and test connections directly within the ACB interface, automatically populate connection fields using metadata provided by the connector, and save and manage connection configurations without switching to the XML view. 
+In this panel, you can create, edit, delete, and test connections directly within the IDE interface, automatically populate connection fields using metadata provided by the connector, and save and manage connection configurations without switching to the XML view. 
 
 To open the configuration panel: 
 
-* Click on an existing component, or add a new one.
+* Select an existing component, or add a new one.
 * Click the *+* icon.
 +
 This action displays the configuration panel, for example:

modules/ROOT/pages/_partials/acb-reusable-steps.adoc

@@ -509,7 +509,7 @@ When the AsyncAPI feature is available for your organization, the Anypoint Code
 
 //
 // tag::start-implementation[]
-. From *Quick Actions*, click *Implement an API*:
+. From *Create*, click *Implement an API*:
 +
 image:anypoint-code-builder::implement-api-option-mat.png["*Implement an API* link highlighted in the *Getting Started* section"]
 . Complete the *Implement an API Specification* form:

modules/ROOT/pages/_partials/acb-start-desktop.adoc

@@ -73,7 +73,7 @@ Ensure this option is checked.
 [[acb-menu]]
 image::anypoint-code-builder-view.png["MuleSoft icon for Anypoint Code Builder in the activity bar"]
 
-. Check that the IDE loads the <<acb-menu, Anypoint Code Builder menu>> with *Quick Actions* and *Documentation* links.
+. Check that the IDE loads the <<acb-menu, Anypoint Code Builder menu>>.
 
 . If you have an Anypoint Platform account running in the EU cloud, change the *Mule: Control Plane* setting to *EU cloud*. 
 +

modules/ROOT/pages/af-create-agent-network.adoc

@@ -27,7 +27,7 @@ To get started try one of these suggested prompts.
 
 . If you're not logged in, log in to your Anypoint Platform account.
 . In Anypoint Code Builder choose on of the following:
-  * In Quick Actions, select *Create an Agent Network*.
+  * In Create, select *Create an Agent Network*.
   * From the Command Palette, run this command: *MuleSoft: Create an Agent Network Project*.
 . Enter a name for the project and select the location to create the project.
 . Select the business group associated with the target space you created in xref:anypoint-code-builder::af-get-started.adoc[Get Started with Agent Networks]. The business group you select must be the same business group you selected when you created the target space.

modules/ROOT/pages/ai-enabling-api-project-topic-center.adoc

@@ -41,9 +41,9 @@ See the xref:tutorials.adoc[] for details.
 include::partial$acb-reusable-steps.adoc[tags="open-ide"]
 +
 image::anypoint-code-builder-view.png["Anypoint Code Builder icon highlighted in the activity bar"]
-. From *Quick Actions*, click *Design an API*:
+. From *Create*, click *Design an API*:
 +
-image::design-api-1.png["*Design an API* link highlighted in the *Quick Actions* section"]
+image::design-api-1.png["*Design an API* link highlighted in the *Create* section"]
 . Select *Enable this API for Agent Topics and Actions*.
 . Complete the *API Specification* form:
 +

modules/ROOT/pages/des-create-api-fragments.adoc

@@ -56,9 +56,9 @@ To create an API spec fragment:
 include::partial$acb-reusable-steps.adoc[tags="open-ide"]
 +
 image::anypoint-code-builder-view.png["Anypoint Code Builder icon highlighted in the activity bar"]
-. From *Quick Actions*, click *Design an API*:
+. From *Create*, click *Design an API*:
 +
-image::design-api-1.png["*Design an API* link highlighted in the *Quick Actions* section"]
+image::design-api-1.png["*Design an API* link highlighted in the *Create* section"]
 . In *Design an API*, click the *API Fragment* tab:
 +
 image:des-api-fragment.png["API Fragment tab on the Design an API page"]

modules/ROOT/pages/des-create-api-specs.adoc

@@ -37,9 +37,9 @@ To create an API spec project in Anypoint Code Builder:
 include::partial$acb-reusable-steps.adoc[tags="open-ide"]
 +
 image::anypoint-code-builder-view.png["Anypoint Code Builder icon highlighted in the activity bar"]
-. From *Quick Actions*, click *Design an API*:
+. From *Create*, click *Design an API*:
 +
-image::design-api-1.png["*Design an API* link highlighted in the *Quick Actions* section"]
+image::design-api-1.png["*Design an API* link highlighted in the *Create* section"]
 
 . Complete the *API Specification* form:
 +

modules/ROOT/pages/des-create-asyncapi-api-specs.adoc

@@ -32,9 +32,9 @@ To create and design an AsyncAPI spec project in Anypoint Code Builder:
 include::partial$acb-reusable-steps.adoc[tags="open-ide"]
 +
 image::anypoint-code-builder-view.png["Anypoint Code Builder icon highlighted in the activity bar"]
-. From *Quick Actions*, click *Design an API*:
+. From *Create*, click *Design an API*:
 +
-image::design-api-1.png["*Design an API* link highlighted in the *Quick Actions* section"]
+image::design-api-1.png["*Design an API* link highlighted in the *Create* section"]
 
 . Complete the *API Specification* form:
 +

modules/ROOT/pages/des-design-grpc-api-spec.adoc

@@ -0,0 +1,151 @@
+= Designing a gRPC API Specification with Anypoint Code Builder
+:page-deployment-options: cloud-ide, desktop-ide
+
+include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"]
+
+Anypoint Code Builder supports designing gRPC API specifications using Protocol Buffers 3 (Protobuf 3). Create and edit `.proto` files, import reusable Protobuf libraries from Anypoint Exchange, and use syntax highlighting and validation. gRPC uses HTTP/2 and supports four RPC patterns:
+
+* Unary
+* Client streaming
+* Server streaming
+* Bidirectional streaming
+
+You author service and message definitions in `.proto` files and can reuse shared types by importing Protobuf fragments (libraries) from Exchange.
+
+== Before You Begin
+
+* xref:start-acb.adoc[].
+* Understand the basics of gRPC and Protocol Buffers (Protobuf 3). See https://grpc.io/docs/what-is-grpc/introduction/[Introduction to gRPC] and the https://protobuf.dev/programming-guide/proto3/[Protocol Buffers 3 Language Guide].
+* Have some familiarity with xref:access-management::business-groups.adoc[].
+
+== Create a New gRPC API Specification Project
+
+To create a gRPC API spec project in Anypoint Code Builder:
+
+include::partial$acb-reusable-steps.adoc[tags="open-ide"]
+
+. From *Create*, click *Design an API*:
+. Complete the *API Specification* form:
++
+[%header,cols="20a,60a"]
+|===
+| Field Name | Field Value
+
+| *Project Name* | Unique name for your project.
+
+This name is used as the API spec title in Exchange, the name of the spec file, and the name of the project's root directory.
+
+include::partial$acb-reusable-steps.adoc[tags="no-project-name-reuse"]
+| *Project Location* | Your home directory or another directory you create.
+
+See xref:start-add-folders.adoc[].
+
+include::partial$acb-reusable-steps.adoc[tags="proj-directory-warn"]
+| *API Type* | The type of API spec to create.
+
+Select *gRPC API* to create a gRPC project.
+
+| *API Specification Language* | The language for the API specification.
+
+Select *Protobuf 3* for gRPC API projects.
+|===
+. Click *Create Project*.
++
+If prompted, trust the authors of the files in the folder.
++
+When the project is ready, the API project opens with a default `.proto` file in the Editor view.
++
+. Continue designing your gRPC API spec.
++
+As you enter elements, use xref:start-discover-ui.adoc#auto-complete[auto-complete] (or press Ctrl+Space) to display available options within the context.
+
+== Organize gRPC API Projects and Dependencies
+
+A new gRPC API project includes a root `.proto` file (for example, `main.proto` or a file named after your project) that defines your service and messages.
+
+Edit the main `.proto` file to define `service`, `rpc`, and `message` blocks. To reuse shared types, add new `.proto` files in the same project and import them. You can also add a Protobuf fragment as a dependency from Exchange and import it in your specification.
+
+== Publish a gRPC Fragment to Exchange
+
+Publish reusable `.proto` definitions as a fragment to Anypoint Exchange so other gRPC API specifications can import them as dependencies.
+
+A fragment contains shared definitions such as `message` or `enum` blocks.
+
+=== Publish the Fragment
+
+To publish a gRPC fragment to Exchange:
+
+. Ensure that you're logged in to Anypoint Platform.
+. Open the project that contains your reusable `.proto` files.
+. From the IDE, select the publish action.
+. When prompted:
++
+* Select the business group.
+* Provide the asset name and version.
+* Add any required metadata.
+. Confirm the publication.
+
+After publishing, the fragment appears in Exchange as an API Fragment asset and can be added as a dependency to other gRPC API specification projects.
+
+To use the fragment in another gRPC API specification:
+
+. Add the fragment as a dependency from Exchange.
+. Import the corresponding `.proto` file in your main specification.
+. Validate that all references resolve correctly.
+
+== Import a Protobuf Library from Anypoint Exchange
+
+Import reusable Protobuf libraries (fragments) from Anypoint Exchange and add them as dependencies to your gRPC API project. You can reuse messages and services across multiple specifications.
+
+To use a Protobuf fragment published to Exchange:
+
+. Ensure you're logged in to Anypoint Platform.
+. Open your gRPC API project.
+. Open the Command Palette (Cmd+Shift+P on macOS or Ctrl+Shift+P on Windows).
+. Select *MuleSoft: Add Fragment dependency from Exchange*.
+. Search for the Protobuf fragment you need and select the version to add.
+. After the dependency is added, the library is available under the project.
+. In your main `.proto` file, use `import` to reference the library's package and message or service definitions. For example:
++
+[source,protobuf]
+----
+syntax = "proto3";
+
+import "path/to/library.proto";
+
+service MyService {
+  rpc GetOrder(OrderRequest) returns (OrderResponse);
+}
+----
+. Save the spec. Anypoint Code Builder resolves the dependency and validates references. You can reuse messages and services from the imported library across your gRPC specs.
+
+== Define Technical Details for gRPC Specifications
+
+Specify RPC communication patterns in your service definitions and use built-in validation to verify your Protobuf specification.
+
+=== Declare Communication Patterns for gRPC Services
+
+Anypoint Code Builder and Mule runtime support all four gRPC RPC patterns:
+
+* **Unary** – Single request, single response.
+* **Client streaming** – Client sends a stream of messages; server returns a single response.
+* **Server streaming** – Client sends a single request; server returns a stream of messages.
+* **Bidirectional streaming** – Both client and server send and receive streams of messages.
+
+Define these in your `.proto` file using the appropriate `rpc` declarations and stream modifiers.
+
+=== Verify Specification Accuracy with Syntax Validation
+
+Anypoint Code Builder provides syntax highlighting and validation for Protobuf 3 specifications. Validation is performed using the API Modeling Framework (AMF) parser, so you get inline feedback and error reporting as you edit your `.proto` files. Use the editor and the xref:start-open-output-panel.adoc[output panel] to track validation and scaffolding status.
+
+== See Also
+
+// TODO: Include a link to gRPC Connector docs.
+* xref:start-acb.adoc[]
+* xref:imp-implement-grpc-api-spec.adoc[]
+* xref:des-designing-api-specs.adoc[]
+* xref:des-create-api-specs.adoc[]
+* xref:des-create-api-fragments.adoc[]
+* xref:des-publish-grpc-api-to-exchange.adoc[]
+* xref:des-publish-api-spec-to-exchange.adoc[]
+* xref:start-discover-ui.adoc#use-autocomplete[Use Auto-Complete in the Editors]