Skip to content

Commit a7d9bf0

Browse files
committed
Document tags
1 parent e812ed8 commit a7d9bf0

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,27 @@ service ExampleService {
4141
}
4242
```
4343

44+
#### (nexus.v1.service).tags
45+
46+
`repeated string`
47+
48+
Tags a Nexus Service. Used by code generators for Service inclusion and exclusion.
49+
50+
**Example:**
51+
52+
```protobuf
53+
syntax = "proto3";
54+
55+
package example.v1;
56+
57+
import "nexus/v1/options.proto";
58+
59+
service ExampleService {
60+
option (nexus.v1.service).tags = "tag1";
61+
option (nexus.v1.service).tags = "tag2";
62+
}
63+
```
64+
4465
### Method
4566

4667
#### (nexus.v1.operation).name
@@ -65,6 +86,29 @@ service ExampleService {
6586
}
6687
```
6788

89+
#### (nexus.v1.operation).tags
90+
91+
`repeated string`
92+
93+
Tags a Nexus Service. Used by code generators for Operation inclusion and exclusion.
94+
95+
**Example:**
96+
97+
```protobuf
98+
syntax = "proto3";
99+
100+
package example.v1;
101+
102+
import "nexus/v1/options.proto";
103+
104+
service ExampleService {
105+
rpc Foo(FooInput) returns (FooResponse) {
106+
option (nexus.v1.operation).tags = "tag1";
107+
option (nexus.v1.operation).tags = "tag2";
108+
}
109+
}
110+
```
111+
68112
## Contribute
69113

70114
### Generate Go files

0 commit comments

Comments
 (0)