Skip to content

Commit e419233

Browse files
xiaolanzgeeknoid
authored andcommitted
Update broker API package. (#334)
* Update broker package. * change to dev * hide from docs
1 parent 0318d4c commit e419233

File tree

7 files changed

+68
-216
lines changed

7 files changed

+68
-216
lines changed

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,15 +145,15 @@ generate: generate-broker-go generate-mesh-go generate-mixer-go generate-routing
145145
# broker/...
146146
#####################
147147

148-
broker_v1_path := broker/v1/config
148+
broker_v1_path := broker/dev
149149
broker_v1_protos := $(shell find $(broker_v1_path) -type f -name '*.proto' | sort)
150150
broker_v1_pb_gos := $(broker_v1_protos:.proto=.pb.go)
151-
broker_v1_pb_doc := $(broker_v1_path)/istio.broker.v1.config.pb.html
151+
broker_v1_pb_doc := $(broker_v1_path)/istio.broker.dev.pb.html
152152

153153
generate-broker-go: $(broker_v1_pb_gos) $(broker_v1_pb_doc)
154154

155155
$(broker_v1_pb_gos) $(broker_v1_pb_doc): $(broker_v1_protos) | depend $(protoc_gen_go) $(protoc_bin)
156-
## Generate broker/v1/config/*.pb.go + $(broker_v1_pb_doc)
156+
## Generate broker/dev/*.pb.go + $(broker_v1_pb_doc)
157157
$(protoc) $(proto_path) $(protoc_gen_go_plugin) $(protoc_gen_docs_plugin)$(broker_v1_path) $^
158158

159159
clean-broker-generated:

broker/dev/istio.broker.dev.pb.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Service Broker
3+
overview: Configuration affecting the Istio service broker
4+
location: https://istio.io/docs/reference/config/istio.broker.dev.html
5+
layout: protoc-gen-docs
6+
---

broker/v1/config/service_class.pb.go renamed to broker/dev/service_class.pb.go

Lines changed: 28 additions & 26 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

broker/v1/config/service_class.proto renamed to broker/dev/service_class.proto

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,13 @@ syntax = "proto3";
1515

1616
// $title: Service Broker
1717
// $overview: Configuration affecting the Istio service broker
18-
// $location: https://istio.io/docs/reference/config/istio.broker.v1.config.html
18+
// $location: https://istio.io/docs/reference/config/istio.broker.dev.html
1919

20-
package istio.broker.v1.config;
20+
package istio.broker.dev;
2121

22-
option go_package="istio.io/api/broker/v1/config";
22+
option go_package="istio.io/api/broker/dev";
2323

24+
// $hide_from_docs
2425
// ServiceClass defines a service that are exposed to Istio service consumers.
2526
// The service is linked into one or more ServicePlan.
2627
message ServiceClass {
@@ -31,12 +32,14 @@ message ServiceClass {
3132
CatalogEntry entry = 2;
3233
}
3334

35+
// $hide_from_docs
3436
// Deployment defines how the service instances are deployed.
3537
message Deployment {
3638
// For truely multi-tenant service, the deployed service instance name.
3739
string instance = 1;
3840
}
3941

42+
// $hide_from_docs
4043
// CatalogEntry defines listing information for this service within the exposed
4144
// catalog. The message is a subset of OSBI service fields defined in
4245
// https://github.com/openservicebrokerapi

broker/v1/config/service_plan.pb.go renamed to broker/dev/service_plan.pb.go

Lines changed: 21 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

broker/v1/config/service_plan.proto renamed to broker/dev/service_plan.proto

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@
1313
// limitations under the License.
1414
syntax = "proto3";
1515

16-
package istio.broker.v1.config;
16+
package istio.broker.dev;
1717

18-
option go_package="istio.io/api/broker/v1/config";
18+
option go_package="istio.io/api/broker/dev";
1919

20+
// $hide_from_docs
2021
// ServicePlan defines the type of services available to Istio service
2122
// consumers. One or more services are included in a plan. The plan is flexible
2223
// and subject to change along with business requirements.
@@ -30,6 +31,7 @@ message ServicePlan {
3031
repeated string services = 2;
3132
}
3233

34+
// $hide_from_docs
3335
// CatalogPlan defines listing information for this service plan within the
3436
// exposed catalog. The message is a subset of OSBI plan fields defined in
3537
// https://github.com/openservicebrokerapi

0 commit comments

Comments
 (0)