Skip to content

Commit 9688095

Browse files
authored
Update README.md to indicate expected ArtifactResponses
The current /gnoi/healthz/README.md is not explicit to vendors on what ArtifactResponses order is expected for each artifact. This update explicitly defines the ArtifactResponse order expected for each artifact.
1 parent 871776a commit 9688095

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

healthz/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,11 @@ is implemented as a server-side streaming RPC. The `Artifact` RPC ensures that
174174
a target sends these potentially large artifacts only when explicitly requested
175175
by the client.
176176

177-
###test
177+
Each artifact that is returned in the `Artifact` RPC call should contain
178+
ArtifactResponses in the following order:
179+
- ArtifactHeader
180+
- one or more bytes/proto
181+
- ArtifactTrailer
178182

179183
#### Healthz.Check()
180184

0 commit comments

Comments
 (0)