Skip to content

Commit da0e085

Browse files
authored
add description on /api/v1/index/retrieve endpoint (sigstore#1073)
Signed-off-by: Bob Callaway <bcallaway@google.com> Signed-off-by: Bob Callaway <bcallaway@google.com>
1 parent 25f429c commit da0e085

File tree

4 files changed

+18
-2
lines changed

4 files changed

+18
-2
lines changed

openapi.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ paths:
3232
/api/v1/index/retrieve:
3333
post:
3434
summary: Searches index by entry metadata
35+
description: >
36+
EXPERIMENTAL - this endpoint is offered as best effort only and may be changed or removed in future releases.
37+
38+
The results returned from this endpoint may be incomplete.
39+
deprecated: true
3540
operationId: searchIndex
3641
tags:
3742
- index

pkg/generated/client/index/index_client.go

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/generated/restapi/embedded_spec.go

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

pkg/generated/restapi/operations/index/search_index.go

Lines changed: 4 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)