Skip to content

Commit 08ee0eb

Browse files
author
stlc-bot
committed
feat(logs): expose request log endpoints in SDKs (#1025)
Stainless-Generated-From: 3211b8270afdd0df5d7118e384cf0fd333ab9f5c
1 parent 7e03bf3 commit 08ee0eb

4 files changed

Lines changed: 235 additions & 1 deletion

File tree

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
configured_endpoints: 45
1+
configured_endpoints: 47

‎pkg/cmd/cmd.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,15 @@ func init() {
206206
&newsSearch,
207207
},
208208
},
209+
{
210+
Name: "logs",
211+
Category: "API RESOURCE",
212+
Suggest: true,
213+
Commands: []*cli.Command{
214+
&logsRetrieve,
215+
&logsList,
216+
},
217+
},
209218
{
210219
Name: "@manpages",
211220
Usage: "Generate documentation for 'man'",

‎pkg/cmd/log.go‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2+
3+
package cmd
4+
5+
import (
6+
"context"
7+
"fmt"
8+
9+
"github.com/context-dot-dev/context-dev-cli/internal/apiquery"
10+
"github.com/context-dot-dev/context-dev-cli/internal/requestflag"
11+
"github.com/context-dot-dev/context-go-sdk/v2"
12+
"github.com/context-dot-dev/context-go-sdk/v2/option"
13+
"github.com/tidwall/gjson"
14+
"github.com/urfave/cli/v3"
15+
)
16+
17+
var logsRetrieve = cli.Command{
18+
Name: "retrieve",
19+
Usage: "Get one logged API call, including its request input and response body.",
20+
Suggest: true,
21+
Flags: []cli.Flag{
22+
&requestflag.Flag[string]{
23+
Name: "request-id",
24+
Usage: "The request ID of the logged API call.",
25+
Required: true,
26+
PathParam: "request_id",
27+
},
28+
},
29+
Action: handleLogsRetrieve,
30+
HideHelpCommand: true,
31+
}
32+
33+
var logsList = cli.Command{
34+
Name: "list",
35+
Usage: "List your organization's API requests, newest first. Defaults to the last 24\nhours.",
36+
Suggest: true,
37+
Flags: []cli.Flag{
38+
&requestflag.Flag[string]{
39+
Name: "error-code",
40+
Usage: "Filter by the `error_code` returned in the response.",
41+
QueryPath: "error_code",
42+
},
43+
&requestflag.Flag[bool]{
44+
Name: "errors-only",
45+
Usage: "Only include requests that returned a 4xx or 5xx status.",
46+
Default: false,
47+
QueryPath: "errors_only",
48+
},
49+
&requestflag.Flag[any]{
50+
Name: "from",
51+
Usage: "Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours before `to`.",
52+
QueryPath: "from",
53+
},
54+
&requestflag.Flag[string]{
55+
Name: "key-id",
56+
Usage: "Filter by the API key that made the request.",
57+
QueryPath: "key_id",
58+
},
59+
&requestflag.Flag[int64]{
60+
Name: "limit",
61+
Usage: "Number of log entries per page.",
62+
Default: 50,
63+
QueryPath: "limit",
64+
},
65+
&requestflag.Flag[int64]{
66+
Name: "page",
67+
Usage: "Page number, starting at 1.",
68+
Default: 1,
69+
QueryPath: "page",
70+
},
71+
&requestflag.Flag[string]{
72+
Name: "path",
73+
Usage: "Filter by endpoint path, with or without the /v1 prefix.",
74+
QueryPath: "path",
75+
},
76+
&requestflag.Flag[string]{
77+
Name: "search",
78+
Usage: "Case-insensitive substring match against the request query and body, e.g. a domain.",
79+
QueryPath: "search",
80+
},
81+
&requestflag.Flag[int64]{
82+
Name: "status-code",
83+
Usage: "Filter by exact HTTP status code.",
84+
QueryPath: "status_code",
85+
},
86+
&requestflag.Flag[string]{
87+
Name: "tags",
88+
Usage: "Comma-separated request tags. Matches requests carrying any of them. Up to 20 tags, each 1-50 characters.",
89+
QueryPath: "tags",
90+
},
91+
&requestflag.Flag[any]{
92+
Name: "to",
93+
Usage: "Only include requests at or before this ISO 8601 timestamp. Defaults to now.",
94+
QueryPath: "to",
95+
},
96+
},
97+
Action: handleLogsList,
98+
HideHelpCommand: true,
99+
}
100+
101+
func handleLogsRetrieve(ctx context.Context, cmd *cli.Command) error {
102+
client := contextdev.NewClient(getDefaultRequestOptions(cmd)...)
103+
unusedArgs := cmd.Args().Slice()
104+
if !cmd.IsSet("request-id") && len(unusedArgs) > 0 {
105+
cmd.Set("request-id", unusedArgs[0])
106+
unusedArgs = unusedArgs[1:]
107+
}
108+
if len(unusedArgs) > 0 {
109+
return fmt.Errorf("Unexpected extra arguments: %v", unusedArgs)
110+
}
111+
112+
options, err := flagOptions(
113+
cmd,
114+
apiquery.NestedQueryFormatBrackets,
115+
apiquery.ArrayQueryFormatComma,
116+
EmptyBody,
117+
false,
118+
)
119+
if err != nil {
120+
return err
121+
}
122+
123+
var res []byte
124+
options = append(options, option.WithResponseBodyInto(&res))
125+
_, err = client.Logs.Get(ctx, cmd.Value("request-id").(string), options...)
126+
if err != nil {
127+
return err
128+
}
129+
130+
obj := gjson.ParseBytes(res)
131+
format := cmd.Root().String("format")
132+
explicitFormat := cmd.Root().IsSet("format")
133+
transform := cmd.Root().String("transform")
134+
return ShowJSON(obj, ShowJSONOpts{
135+
ExplicitFormat: explicitFormat,
136+
Format: format,
137+
RawOutput: cmd.Root().Bool("raw-output"),
138+
Title: "logs retrieve",
139+
Transform: transform,
140+
})
141+
}
142+
143+
func handleLogsList(ctx context.Context, cmd *cli.Command) error {
144+
client := contextdev.NewClient(getDefaultRequestOptions(cmd)...)
145+
unusedArgs := cmd.Args().Slice()
146+
147+
if len(unusedArgs) > 0 {
148+
return fmt.Errorf("Unexpected extra arguments: %v", unusedArgs)
149+
}
150+
151+
options, err := flagOptions(
152+
cmd,
153+
apiquery.NestedQueryFormatBrackets,
154+
apiquery.ArrayQueryFormatComma,
155+
EmptyBody,
156+
false,
157+
)
158+
if err != nil {
159+
return err
160+
}
161+
162+
params := contextdev.LogListParams{}
163+
164+
var res []byte
165+
options = append(options, option.WithResponseBodyInto(&res))
166+
_, err = client.Logs.List(ctx, params, options...)
167+
if err != nil {
168+
return err
169+
}
170+
171+
obj := gjson.ParseBytes(res)
172+
format := cmd.Root().String("format")
173+
explicitFormat := cmd.Root().IsSet("format")
174+
transform := cmd.Root().String("transform")
175+
return ShowJSON(obj, ShowJSONOpts{
176+
ExplicitFormat: explicitFormat,
177+
Format: format,
178+
RawOutput: cmd.Root().Bool("raw-output"),
179+
Title: "logs list",
180+
Transform: transform,
181+
})
182+
}

‎pkg/cmd/log_test.go‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2+
3+
package cmd
4+
5+
import (
6+
"testing"
7+
8+
"github.com/context-dot-dev/context-dev-cli/internal/mocktest"
9+
)
10+
11+
func TestLogsRetrieve(t *testing.T) {
12+
t.Skip("Mock server tests are disabled")
13+
t.Run("regular flags", func(t *testing.T) {
14+
mocktest.TestRunMockTestWithFlags(
15+
t,
16+
"--api-key", "string",
17+
"logs", "retrieve",
18+
"--request-id", "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
19+
)
20+
})
21+
}
22+
23+
func TestLogsList(t *testing.T) {
24+
t.Skip("Mock server tests are disabled")
25+
t.Run("regular flags", func(t *testing.T) {
26+
mocktest.TestRunMockTestWithFlags(
27+
t,
28+
"--api-key", "string",
29+
"logs", "list",
30+
"--error-code", "WEBSITE_ACCESS_ERROR",
31+
"--errors-only=true",
32+
"--from", "'2026-09-10T00:00:00Z'",
33+
"--key-id", "x",
34+
"--limit", "1",
35+
"--page", "1",
36+
"--path", "/brand/retrieve",
37+
"--search", "acme.com",
38+
"--status-code", "500",
39+
"--tags", "nightly-import,team-alpha",
40+
"--to", "'2026-09-11T00:00:00Z'",
41+
)
42+
})
43+
}

0 commit comments

Comments
 (0)