You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 3fc839d
Browse filesBrowse the repository at this point in the historyBrowse files
stlc-bot
committed
docs(openapi): complete concise API reference metadata (#1329)
Usage: "Retrieve logos, backdrops, colors, industry, description, and more. Provide\nexactly one lookup identifier in the request body: a domain, company name, email\naddress, stock ticker, transaction descriptor, or direct URL. Note:\n`by_direct_url` fetches brand data only from the provided URL — not from the\nentire internet.",
19
+
Usage: "Retrieve logos, colors, company details, and social links using one lookup\nidentifier. A direct URL limits extraction to that page.",
20
20
Suggest: true,
21
21
Flags: []cli.Flag{
22
22
&requestflag.Flag[string]{
@@ -37,7 +37,7 @@ var brandRetrieve = requestflag.WithInnerFlags(cli.Command{
37
37
},
38
38
&requestflag.Flag[int64]{
39
39
Name: "max-age-ms",
40
-
Usage: "Maximum age in milliseconds for cached brand data before the API performs a hard refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms) are clamped to 1 year.",
40
+
Usage: "Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1 year. `0` refreshes.",
41
41
BodyPath: "maxAgeMs",
42
42
},
43
43
&requestflag.Flag[bool]{
@@ -47,12 +47,12 @@ var brandRetrieve = requestflag.WithInnerFlags(cli.Command{
47
47
},
48
48
&requestflag.Flag[[]string]{
49
49
Name: "tag",
50
-
Usage: "Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.",
50
+
Usage: "Labels for filtering usage in the dashboard.",
51
51
BodyPath: "tags",
52
52
},
53
53
&requestflag.Flag[map[string]any]{
54
54
Name: "timeout-opts",
55
-
Usage: "Optional request deadline and behavior on timeout. For GET requests, use timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded timeoutOpts object.",
55
+
Usage: "Request deadline and what to return when it passes.",
56
56
BodyPath: "timeoutOpts",
57
57
},
58
58
&requestflag.Flag[string]{
@@ -117,20 +117,20 @@ var brandRetrieve = requestflag.WithInnerFlags(cli.Command{
117
117
"timeout-opts": {
118
118
&requestflag.InnerFlag[int64]{
119
119
Name: "timeout-opts.milliseconds",
120
-
Usage: "Request deadline in milliseconds. Maximum: 300000 (5 minutes).",
120
+
Usage: "Deadline in milliseconds.",
121
121
InnerField: "milliseconds",
122
122
},
123
123
&requestflag.InnerFlag[string]{
124
124
Name: "timeout-opts.behavior",
125
-
Usage: `What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging credits. "return-partial" returns usable results collected so far; if none are available, the request still fails without charging credits. Partial results are not cached as complete results.`,
125
+
Usage: `"fail" returns 408 at the deadline. "return-partial" returns available results; inspect the response’s partial flag.`,
126
126
InnerField: "behavior",
127
127
},
128
128
},
129
129
})
130
130
131
131
varbrandSearch= cli.Command{
132
132
Name: "search",
133
-
Usage: "Search indexed brands by name or domain",
133
+
Usage: "Find up to 10 brands by name or domain, ordered by popularity. Use the returned\ndomain to retrieve a full brand profile.",
134
134
Suggest: true,
135
135
Flags: []cli.Flag{
136
136
&requestflag.Flag[string]{
@@ -153,7 +153,7 @@ var brandSearch = cli.Command{
153
153
},
154
154
&requestflag.Flag[[]string]{
155
155
Name: "tag",
156
-
Usage: "Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 characters.",
156
+
Usage: "Comma-separated labels for filtering usage, e.g. `production,team-alpha`.",
Usage: "Classify any brand into 2022 NAICS industry codes from its domain or name.",
19
+
Usage: "Classify a company into NAICS industry codes.",
20
20
Suggest: true,
21
21
Flags: []cli.Flag{
22
22
&requestflag.Flag[string]{
@@ -39,17 +39,17 @@ var industryRetrieveNaics = requestflag.WithInnerFlags(cli.Command{
39
39
},
40
40
&requestflag.Flag[[]string]{
41
41
Name: "tag",
42
-
Usage: "Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 characters.",
42
+
Usage: "Comma-separated labels for filtering usage, e.g. `production,team-alpha`.",
43
43
QueryPath: "tags",
44
44
},
45
45
&requestflag.Flag[map[string]any]{
46
46
Name: "timeout-opts",
47
-
Usage: "Optional request deadline and behavior on timeout. For GET requests, use timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded timeoutOpts object.",
47
+
Usage: "Request deadline and what to return when it passes.",
48
48
QueryPath: "timeoutOpts",
49
49
},
50
50
&requestflag.Flag[string]{
51
51
Name: "zdr",
52
-
Usage: "Set to enabled to bypass shared caches and omit request and response content from retained usage logs. Asset uploads are skipped, so hosted image URLs are omitted. Requires zero data retention to be enabled for your organization (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.",
52
+
Usage: "`enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless your organization has ZDR.",
53
53
Default: "disabled",
54
54
QueryPath: "zdr",
55
55
},
@@ -60,20 +60,20 @@ var industryRetrieveNaics = requestflag.WithInnerFlags(cli.Command{
60
60
"timeout-opts": {
61
61
&requestflag.InnerFlag[int64]{
62
62
Name: "timeout-opts.milliseconds",
63
-
Usage: "Request deadline in milliseconds. Maximum: 300000 (5 minutes).",
63
+
Usage: "Deadline in milliseconds.",
64
64
InnerField: "milliseconds",
65
65
},
66
66
&requestflag.InnerFlag[string]{
67
67
Name: "timeout-opts.behavior",
68
-
Usage: `What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging credits. "return-partial" returns usable results collected so far; if none are available, the request still fails without charging credits. Partial results are not cached as complete results.`,
68
+
Usage: `"fail" returns 408 at the deadline. "return-partial" returns available results; inspect the response’s partial flag.`,
Usage: "Classify any brand into Standard Industrial Classification (SIC) codes from its\ndomain or name. Choose between the original SIC system (`original_sic`) or the\nlatest SIC list maintained by the SEC (`latest_sec`).",
76
+
Usage: "Classify a company into SIC industry codes.",
77
77
Suggest: true,
78
78
Flags: []cli.Flag{
79
79
&requestflag.Flag[string]{
@@ -96,23 +96,23 @@ var industryRetrieveSic = requestflag.WithInnerFlags(cli.Command{
96
96
},
97
97
&requestflag.Flag[[]string]{
98
98
Name: "tag",
99
-
Usage: "Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 characters.",
99
+
Usage: "Comma-separated labels for filtering usage, e.g. `production,team-alpha`.",
100
100
QueryPath: "tags",
101
101
},
102
102
&requestflag.Flag[map[string]any]{
103
103
Name: "timeout-opts",
104
-
Usage: "Optional request deadline and behavior on timeout. For GET requests, use timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded timeoutOpts object.",
104
+
Usage: "Request deadline and what to return when it passes.",
105
105
QueryPath: "timeoutOpts",
106
106
},
107
107
&requestflag.Flag[string]{
108
108
Name: "type",
109
-
Usage: "Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Industrial Classification system; `latest_sec` uses the current SIC list as published by the SEC. Defaults to `original_sic`.",
109
+
Usage: "SIC dataset: `original_sic` (1987) or `latest_sec` (current SEC list).",
110
110
Default: "original_sic",
111
111
QueryPath: "type",
112
112
},
113
113
&requestflag.Flag[string]{
114
114
Name: "zdr",
115
-
Usage: "Set to enabled to bypass shared caches and omit request and response content from retained usage logs. Asset uploads are skipped, so hosted image URLs are omitted. Requires zero data retention to be enabled for your organization (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.",
115
+
Usage: "`enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless your organization has ZDR.",
116
116
Default: "disabled",
117
117
QueryPath: "zdr",
118
118
},
@@ -123,12 +123,12 @@ var industryRetrieveSic = requestflag.WithInnerFlags(cli.Command{
123
123
"timeout-opts": {
124
124
&requestflag.InnerFlag[int64]{
125
125
Name: "timeout-opts.milliseconds",
126
-
Usage: "Request deadline in milliseconds. Maximum: 300000 (5 minutes).",
126
+
Usage: "Deadline in milliseconds.",
127
127
InnerField: "milliseconds",
128
128
},
129
129
&requestflag.InnerFlag[string]{
130
130
Name: "timeout-opts.behavior",
131
-
Usage: `What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging credits. "return-partial" returns usable results collected so far; if none are available, the request still fails without charging credits. Partial results are not cached as complete results.`,
131
+
Usage: `"fail" returns 408 at the deadline. "return-partial" returns available results; inspect the response’s partial flag.`,
0 commit comments