Query on Camunda 8 Swagger UI

camundabpmlearner · October 5, 2023, 5:16am

Hi,
I’m using camunda 8(zeebe,hazelcast, zeebe simple monitor), my question is how can I bring swagger feature of zeebe?
I tried to load camunda-platform-rest-api image but it needs operate so need help here.

Thank you in advance

nathan.loding · October 5, 2023, 7:02pm

Hi @camundabpmlearner - I don’t believe Zeebe has a Swagger documented, because it uses gRPC rather than REST. What are you looking to use the document/API for? Perhaps there’s an alternative.

The camunda-platform-rest-api project is a community maintained project, not an official Camunda product, and is not fully featured yet (always looking for contributors!). It is intended to provided a unified REST API for all of Camunda’s services, and that is likely where the current dependency comes from.

camundabpmlearner · October 6, 2023, 1:49am

Hi @nathan.loding
Im looking for a list of available API’s to see what all functionality is achievable and what are their inputs.

I believe SwaggerUI helps here. If there is any alternative for gRPC for this, kindly share.

nathan.loding · October 6, 2023, 2:51pm

I believe this gateway.proto file is the closest you can get to a Swagger/OpenAPI spec file for gRPC?

github.com

camunda/zeebe/blob/3c87c94eb383973fb81a482ede2ea72049e45dde/gateway-protocol/src/main/proto/gateway.proto

syntax = 'proto3';
package gateway_protocol;

option java_multiple_files = false;
option java_package = "io.camunda.zeebe.gateway.protocol";
option go_package = "./;pb";

// For a more complete documentation, refer to Zeebe documentation at:
// https://docs.camunda.io/docs/reference/grpc

message StreamActivatedJobsRequest {
  // the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
  // type="payment-service" />)
  string type = 1;
  // the name of the worker activating the jobs, mostly used for logging purposes
  string worker = 2;
  // a job returned after this call will not be activated by another call until the
  // timeout (in ms) has been reached
  int64 timeout = 3;
  // a list of variables to fetch as the job variables; if empty, all visible variables at

This file has been truncated. show original