Skip to content

Commit e12dd69

Browse files
committed
fix: use angle brackets for API key placeholder to avoid Gitleaks warnings
Changed YOUR_API_KEY to <YOUR_API_KEY> across all API docs
1 parent 74b67c3 commit e12dd69

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

frontend/src/pages/api/APIAnalysisPage.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export function APIAnalysisPage() {
7272

7373
<h4 className="text-sm font-semibold text-gray-400 uppercase tracking-wider mt-6 mb-2">Example</h4>
7474
<DocsCodeBlock language="bash">
75-
{`curl -H "Authorization: Bearer YOUR_API_KEY" \\
75+
{`curl -H "Authorization: Bearer <YOUR_API_KEY>" \\
7676
http://localhost:8000/api/v1/repos/repo_abc123/dependencies`}
7777
</DocsCodeBlock>
7878

@@ -127,7 +127,7 @@ export function APIAnalysisPage() {
127127
<h4 className="text-sm font-semibold text-gray-400 uppercase tracking-wider mt-6 mb-2">Example</h4>
128128
<DocsCodeBlock language="bash">
129129
{`curl -X POST \\
130-
-H "Authorization: Bearer YOUR_API_KEY" \\
130+
-H "Authorization: Bearer <YOUR_API_KEY>" \\
131131
-H "Content-Type: application/json" \\
132132
-d '{"file_path": "src/auth/middleware.py"}' \\
133133
http://localhost:8000/api/v1/repos/repo_abc123/impact`}
@@ -216,7 +216,7 @@ export function APIAnalysisPage() {
216216

217217
<h4 className="text-sm font-semibold text-gray-400 uppercase tracking-wider mt-6 mb-2">Example</h4>
218218
<DocsCodeBlock language="bash">
219-
{`curl -H "Authorization: Bearer YOUR_API_KEY" \\
219+
{`curl -H "Authorization: Bearer <YOUR_API_KEY>" \\
220220
http://localhost:8000/api/v1/repos/repo_abc123/insights`}
221221
</DocsCodeBlock>
222222

frontend/src/pages/api/APIOverviewPage.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ https://api.opencodeintel.com/api/v1`}
5959
</p>
6060

6161
<DocsCodeBlock language="bash">
62-
{`curl -H "Authorization: Bearer YOUR_API_KEY" \\
62+
{`curl -H "Authorization: Bearer <YOUR_API_KEY>" \\
6363
http://localhost:8000/api/v1/repos`}
6464
</DocsCodeBlock>
6565

frontend/src/pages/api/APIRepositoriesPage.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export function APIRepositoriesPage() {
5353

5454
<h4 className="text-sm font-semibold text-gray-400 uppercase tracking-wider mt-6 mb-2">Example</h4>
5555
<DocsCodeBlock language="bash">
56-
{`curl -H "Authorization: Bearer YOUR_API_KEY" \\
56+
{`curl -H "Authorization: Bearer <YOUR_API_KEY>" \\
5757
http://localhost:8000/api/v1/repos`}
5858
</DocsCodeBlock>
5959

@@ -115,7 +115,7 @@ export function APIRepositoriesPage() {
115115
<h4 className="text-sm font-semibold text-gray-400 uppercase tracking-wider mt-6 mb-2">Example</h4>
116116
<DocsCodeBlock language="bash">
117117
{`curl -X POST \\
118-
-H "Authorization: Bearer YOUR_API_KEY" \\
118+
-H "Authorization: Bearer <YOUR_API_KEY>" \\
119119
-H "Content-Type: application/json" \\
120120
-d '{"url": "https://github.com/user/my-project"}' \\
121121
http://localhost:8000/api/v1/repos`}

frontend/src/pages/api/APISearchPage.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ export function APISearchPage() {
160160
<h3 className="text-lg font-medium text-white mt-6 mb-3">Basic Search</h3>
161161
<DocsCodeBlock language="bash">
162162
{`curl -X POST \\
163-
-H "Authorization: Bearer YOUR_API_KEY" \\
163+
-H "Authorization: Bearer <YOUR_API_KEY>" \\
164164
-H "Content-Type: application/json" \\
165165
-d '{"query": "error handling", "repo_id": "repo_abc123"}' \\
166166
http://localhost:8000/api/v1/search`}
@@ -169,7 +169,7 @@ export function APISearchPage() {
169169
<h3 className="text-lg font-medium text-white mt-8 mb-3">Search with Filters</h3>
170170
<DocsCodeBlock language="bash">
171171
{`curl -X POST \\
172-
-H "Authorization: Bearer YOUR_API_KEY" \\
172+
-H "Authorization: Bearer <YOUR_API_KEY>" \\
173173
-H "Content-Type: application/json" \\
174174
-d '{
175175
"query": "database connection pool",

0 commit comments

Comments
 (0)