search

opensearch-project / opensearch-api-specification

API specification for OpenSearch
Apache License 2.0
35 stars 62 forks source link

532 publish proto files #676

Open amberzsy opened 2 weeks ago

amberzsy commented 2 weeks ago

Description

publish example protobufs generated with semi-automation tooling

TODO:

  1. add support for compile protos. (make sure no syntax error etc)
  2. generate protobuf language clients in spec repo.

after second thought on proposal, submodule not optimal ideas. probably, we should do

  1. Raw proto (which generated from Spec with certain tooling) defined in /protobuf. it should be machine generated files. But for now, i have it as handwritten ones to unblock grpc poc effort.
  2. protobuf compile should compile the raw proto into *.proto (or some jars) in the release.
  3. similar to opensearch-java which download https://github.com/opensearch-project/opensearch-java/blob/c7103d87423e44aa5ef57bb940496a6e3b74ff78/java-codegen/build.gradle.kts#L75 the output yaml file from release, the Core and OpenSearch-Java or other language client can download/pull from spec repo.

cc: @karenyrx @dblock for review and better idea.

Issues Resolved

532

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

github-actions[bot] commented 2 weeks ago

Spec Test Coverage Analysis

Total Tested
517 349 (67.5 %)
github-actions[bot] commented 2 weeks ago

Changes Analysis

Commit SHA: ad83bfea210c76886c35bdeddc2cd52537cb134d Comparing To SHA: 07e329e8d01fd0576de6a0a3c35412fd5a9163db

API Changes

Summary

NO CHANGES

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11889503341/artifacts/2200450788

API Coverage

Before After Δ
Covered (%) 588 (57.59 %) 588 (57.59 %) 0 (0 %)
Uncovered (%) 433 (42.41 %) 433 (42.41 %) 0 (0 %)
Unknown 35 35 0
dblock commented 1 week ago

Were these authored by hand or a result of a tool?

I'd like to merge a little bit more than this, some kind of useful MVP, that for example contains these files and just enough README information of what they are, maybe some CI.

amberzsy commented 1 week ago

Were these authored by hand or a result of a tool?

for now, it's authored by hand. but eventually it would be machine generated code from spec.

I'd like to merge a little bit more than this, some kind of useful MVP, that for example contains these files and just enough README information of what they are, maybe some CI.

yes, make sense.