Skip to content

Commit 5c131db

Browse files
authored
Merge pull request #10 from StackExchange/stack-internal
Change in naming conventions to Stack Overflow Internal
2 parents 9f255fa + d818d36 commit 5c131db

26 files changed

+91
-74
lines changed

.changeset/four-paws-raise.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"soteams-sdk-docs": patch
3+
"@stackoverflow/teams-sdk": patch
4+
---
5+
6+
Leftover changes from the update in naming conventions to Stack Overflow Internal

.changeset/huge-breads-design.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"soteams-sdk-docs": minor
3+
"@stackoverflow/teams-sdk": minor
4+
---
5+
6+
Changed naming conventions from "Stack Overflow for Teams" and "Stack Overflow Enterprise" to "Stack Overflow Internal" and "Stack Internal Enterprise"

.changeset/tired-papers-sleep.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"soteams-sdk-docs": minor
3+
---
4+
5+
Changed site URL to sdk.stackoverflow.help

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Stack Overflow for Teams SDK
1+
# Stack Overflow Internal SDK
22

33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE)
44
![Status: Early Access](https://img.shields.io/badge/status-early--access-orange)
55

6-
> Official TypeScript SDK for interacting with the **Stack Overflow for Teams API**.
6+
> Official TypeScript SDK for interacting with the **Stack Overflow Internal API**.
77
8-
The Stack Overflow for Teams SDK lets you build powerful applications and integrations on top of your team’s private knowledge base.
8+
The Stack Internal SDK lets you build powerful applications and integrations on top of your team’s private knowledge base.
99

1010
---
1111

1212
## ✨ Features
1313

1414
- 🛠 **Official support** – built and maintained by Stack Overflow with full API coverage.
15-
- 🧑‍💻 **Type safety** – complete TypeScript definitions for all Teams endpoints, models, and responses.
15+
- 🧑‍💻 **Type safety** – complete TypeScript definitions for all Stack Internal endpoints, models, and responses.
1616
- 📚 **Knowledge access** – query questions, answers, and articles from your team’s private repository.
1717
- 👥 **Team management** – access profiles, activity, and collaborate on internal documentation and Q&A.
1818

@@ -40,7 +40,7 @@ yarn add @stackoverflow/teams-sdk
4040

4141
## 📚 Documentation
4242

43-
* [Quick Start Guide](https://sdk.stackoverflowteams.com/)
43+
* [Quick Start Guide](https://sdk.stackoverflow.help/)
4444
* [API v3 Overview](https://stackoverflowteams.help/en/articles/9085836-api-v3-overview)
4545

4646
## 🛠 Contributing
@@ -51,6 +51,6 @@ Contributions are welcome! Please open an [issue](https://github.com/StackExchan
5151

5252
(C) Copyright 2025 Stack Exchange, Inc.
5353

54-
This Stack Overflow for Teams SDK is licensed to you under the terms of the Apache Software License Version 2.0 (Apache 2.0): https://www.apache.org/licenses/LICENSE-2.0.txt
54+
This Stack Overflow Internal SDK is licensed to you under the terms of the Apache Software License Version 2.0 (Apache 2.0): https://www.apache.org/licenses/LICENSE-2.0.txt
5555

56-
The Teams SDK is 100% open source and freely available to download and use under the terms of the Apache 2.0 license. This SDK enables development with the Stack Overflow for Teams API, which is available to all Teams customers, but may be subject to future changes.
56+
The Stack Overflow Internal SDK is 100% open source and freely available to download and use under the terms of the Apache 2.0 license. This SDK enables development with the Stack Internal API, which is available to all Stack Internal customers, but may be subject to future changes.

docs/astro.config.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ import starlight from '@astrojs/starlight';
44

55
// https://astro.build/config
66
export default defineConfig({
7-
site: 'https://sdk.stackoverflowteams.com',
7+
site: 'https://sdk.stackoverflow.help',
88
integrations: [
99
starlight({
1010
favicon: '/favicon.ico',
11-
title: 'Stack Overflow for Teams SDK',
11+
title: 'Stack Overflow Internal SDK',
1212
editLink: {
1313
baseUrl: 'https://github.com/StackExchange/StackOverflowSDK/edit/main/docs',
1414
},

docs/src/content/docs/guides/authentication.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ description: Learn how to authenticate with the Stack Overflow API using the bui
44
---
55
import { Card, CardGrid } from '@astrojs/starlight/components';
66

7-
The Stack Overflow SDK provides built-in authentication helpers that simplify the OAuth 2.0 flow with PKCE for secure token generation. Authentication requirements vary by Stack Overflow for Teams tier.
7+
The Stack Overflow SDK provides built-in authentication helpers that simplify the OAuth 2.0 flow with PKCE for secure token generation. Authentication requirements vary by Stack Internal tier.
88

99
### Authentication by Tier
1010

11-
- **Stack Overflow for Teams Enterprise** - Supports OAuth 2.0 with PKCE. Access tokens can be generated dynamically. You can optionally provide a single Access Token manually.
12-
- **Stack Overflow for Teams Basic/Business** - OAuth is not available. Manual input of Access tokens (PATs) are **required** in order to use the SDK.
11+
- **Stack Internal Enterprise** - Supports OAuth 2.0 with PKCE. Access tokens can be generated dynamically. You can optionally provide a single Access Token manually.
12+
- **Stack Internal Basic/Business** - OAuth is not available. Manual input of Access tokens (PATs) are **required** in order to use the SDK.
1313

1414
### Authentication Clients
1515

@@ -66,7 +66,7 @@ const questions = await teamContext.questions.getAll();
6666
## Authentication Clients (Enterprise Only)
6767

6868
:::note[Enterprise Feature]
69-
Authentication clients are only available for Stack Overflow for Teams Enterprise instances. Basic/Business tiers must use Personal Access Tokens during SDK initialization.
69+
Authentication clients are only available for Stack Internal Enterprise instances. Basic/Business tiers must use Personal Access Tokens during SDK initialization.
7070
:::
7171

7272
### Backend Authentication (Server-Side)
@@ -132,11 +132,11 @@ const success = await frontendClient.submitAccessToken(userToken);
132132

133133
```typescript
134134
interface AuthConfig {
135-
/** OAuth client ID from Stack Overflow Enterprise */
135+
/** OAuth client ID from Stack Internal Enterprise */
136136
clientId: string;
137137
/** Redirect URI registered with your application */
138138
redirectUri: string;
139-
/** Stack Overflow Enterprise instance URL */
139+
/** Stack Internal Enterprise instance URL */
140140
baseUrl: string;
141141
/** OAuth scopes (optional) */
142142
scope?: string;

docs/src/content/docs/guides/quickstart.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Get your Stack Overflow integration running in minutes with our JavaScript SDK.
2929

3030
## Authentication Setup
3131

32-
Before making API calls, you'll need to set up authentication. The approach varies by your Stack Overflow for Teams tier:
32+
Before making API calls, you'll need to set up authentication. The approach varies by your Stack Internal tier:
3333

3434
### Enterprise - OAuth Available
3535
Enterprise instances can use built-in OAuth clients or manual tokens:
@@ -181,7 +181,7 @@ const questions = await sdk.questions.getAll();
181181

182182
## Team Context
183183

184-
For Stack Overflow for Teams, use the team context:
184+
For Stack Internal Basic/Business, use the team context:
185185

186186
```typescript title="team-example.ts"
187187
// Switch to team context

docs/src/content/docs/guides/rate-limiting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: Rate Limiting and Throttling
3-
description: Understanding API throttling and rate limits for Stack Overflow for Teams API v3.
3+
description: Understanding API throttling and rate limits for Stack Overflow Internal API v3.
44
---
55

6-
Stack Overflow for Teams API v3 uses request throttling to prevent abuse and ensure optimum performance for all users. We currently implement two different types of throttling to alleviate excessive API calls: burst throttle rate limiter (short-term) and token bucket rate limiter (long-term). Both throttling methods monitor the number of requests coming from each access token.
6+
Stack Overflow Internal API v3 uses request throttling to prevent abuse and ensure optimum performance for all users. We currently implement two different types of throttling to alleviate excessive API calls: burst throttle rate limiter (short-term) and token bucket rate limiter (long-term). Both throttling methods monitor the number of requests coming from each access token.
77

88
## Burst Throttle Rate Limiter
99

docs/src/content/docs/index.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Welcome to The Stack Overflow for Teams SDK
3-
description: Build powerful applications with the official Stack Overflow for Teams SDK. Access your team's private knowledge base programmatically.
2+
title: Welcome to The Stack Overflow Internal SDK
3+
description: Build powerful applications with the official Stack Internal SDK. Access your team's private knowledge base programmatically.
44
template: splash
55
banner:
66
content: |
77
This SDK is currently in <strong>Early Access</strong>. New features are actively being developed.
88
hero:
9-
tagline: Start building with the Stack Overflow for Teams API using our official SDK
9+
tagline: Start building with the Stack Internal API using our official SDK
1010
image:
1111
light: ../../assets/stackoverflow-black.svg
1212
dark: ../../assets/stackoverflow-white.png
@@ -39,14 +39,14 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
3939
</Card>
4040
</CardGrid>
4141

42-
## Why use the Stack Overflow for Teams SDK?
42+
## Why use the Stack Internal SDK?
4343

4444
<CardGrid>
4545
<Card title="Official Support" icon="approve-check-circle">
46-
Built and maintained by Stack Overflow with full Teams API coverage and guaranteed compatibility.
46+
Built and maintained by Stack Overflow with full Stack Internal API coverage and guaranteed compatibility.
4747
</Card>
4848
<Card title="Type Safety" icon="laptop">
49-
Complete TypeScript definitions for all Teams endpoints, models, and responses.
49+
Complete TypeScript definitions for all Stack Internal endpoints, models, and responses.
5050
</Card>
5151
<Card title="PKCE Authentication Built-in" icon="approve-check-circle">
5252
Includes full PKCE authentication with ready-to-use helpers for both backend and frontend implementations.
@@ -55,11 +55,11 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
5555

5656
## Popular use cases
5757

58-
Whether you're building internal tools, integrating with existing workflows, or creating custom team applications, the Stack Overflow for Teams SDK provides everything you need to leverage your team's collective knowledge.
58+
Whether you're building internal tools, integrating with existing workflows, or creating custom team applications, the Stack Overflow Internal SDK provides everything you need to leverage your team's collective knowledge.
5959

6060
**Internal Tooling**: Build IDE extensions, code review tools, or documentation generators that tap into your team's institutional knowledge.
6161

62-
**Workflow Integration**: Connect your Teams instance with CI/CD pipelines, project management tools, or custom dashboards.
62+
**Workflow Integration**: Connect your Stack Internal instance with CI/CD pipelines, project management tools, or custom dashboards.
6363

6464
**Knowledge Management**: Create applications that help organize, surface, and distribute your team's expertise and best practices.
6565

@@ -72,11 +72,11 @@ This project is in **early access**, and more language support and features will
7272

7373
## Ready to start building?
7474

75-
Our SDK provides a higher-level abstraction for programmatically interacting with Stack Overflow for Teams, removing friction and enabling you to focus on building great experiences for your team.
75+
Our SDK provides a higher-level abstraction for programmatically interacting with Stack Internal, removing friction and enabling you to focus on building great experiences for your team.
7676

7777
## License
7878
(C) Copyright 2025 Stack Exchange, Inc.
7979

80-
This Stack Overflow for Teams SDK is licensed to you under the terms of the Apache Software License Version 2.0 (Apache 2.0): https://www.apache.org/licenses/LICENSE-2.0.txt
80+
This Stack Overflow Internal SDK is licensed to you under the terms of the Apache Software License Version 2.0 (Apache 2.0): https://www.apache.org/licenses/LICENSE-2.0.txt
8181

82-
The Teams SDK is 100% open source and freely available to download and use under the terms of the Apache 2.0 license. This SDK enables development with the Stack Overflow for Teams API, which is available to all Teams customers, but may be subject to future changes.
82+
The Stack Overflow Internal SDK is 100% open source and freely available to download and use under the terms of the Apache 2.0 license. This SDK enables development with the Stack Overflow Internal API, which is available to all Stack Internal customers, but may be subject to future changes.

docs/src/content/docs/users/manage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ const managementData = await safeUserManagement({
515515

516516
## Notes
517517

518-
- **Enterprise Only**: This method is only available in enterprise Stack Overflow context, not for Stack Overflow for Teams.
518+
- **Enterprise Only**: This method is only available in enterprise Stack Overflow context, not for Stack Internal Basic/Business.
519519
- **Admin Privileges**: Requires administrator or moderator permissions to access user management data.
520520
- **Extended User Data**: Provides additional fields like creation dates, modification dates, and deactivation status not available in regular user queries.
521521
- **Date Filtering**: Supports sophisticated date-based filtering for activity analysis and user lifecycle management.

0 commit comments

Comments
 (0)