lorenzhw/gnostic-grpc-deprecated

A gnostic plugin that generates proto definition files (.proto) for REST APIs

• 👋 Hi, I’m @LorenzHW
• 👀 I’m interested in personal growth, sports, and coding
• 👨‍💻 I’m currently working at Cresta where we build cool AI stuff.
• 🔥 In 2019 I implemented the open-source tool gnostic-grpc which converts an OpenAPI spec into protobuf

gnostic-grpc-deprecated's Issues

Generating additionalProperties of a schema

Problem description

additionalProperties are currently not reflected inside the generated .proto. Considering the following OpenAPI definition, an empty message is currently generated for the response.

/testResponseAdditionalProperties:
    get:
      operationId: testResponseAdditionalProperties
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                  format: int32

What would be a proper way to generate additionalProperties inside .proto?

External reference breaks generator

Problem description

An external reference to a schema like this breaks protoreflects protoprint. So far, in order for this generator to work the OpenAPI definition needs to be self-contained.

Generated output format is not ideal.

The generated .proto is not perfectly formatted. For a better looking output a PR for protoreflect needs to be submitted.

included an unresolvable reference to

When generating the proto service i noticed the name of the service message object does not match the created message
Ex. file "spec" included an unresolvable reference to "GET_direct_tenant-id_reference-data_attachments_attachment-idParameters"

But the message does exist just in a different case
md: name:"GET_direct_tenant-Id_reference-Data_attachments_attachment-IdParameters"

it has something to do with the use of - within the path,
/direct/{tenant-id}/reference-data/attachments/{attachment-id}

Generating Enum parameters

Problem description

Enum parameters like in the following OpenAPI definition are currently reflected as int64 param1 = 1; inside the .proto. Therefore the field 'param1' is not limited to the enum values.

paths:
  /testParameterQueryEnum:
    get:
      operationId: testParameterQueryEnum
      parameters:
        - name: param1
          in: query
          schema:
            type: integer
            format: int64
            enum:
              - 1337
              - 1338
              - 1339
            default: 1338

Considering the description of a valid path parameter and a valid query parameter is there a better way to generate enum values?

Gnostic-gRPC project empty

Unable to:

go get -u https://github.com/googleapis/gnostic-grpc

The linked repository is empty