From b3e79b90434a777e39678bf76f2d809f0ed3e168 Mon Sep 17 00:00:00 2001 From: Jwahir Sundai Date: Tue, 17 Mar 2026 17:11:42 -0500 Subject: [PATCH 1/4] add a dedicated api reference page --- docs/references/api-reference.mdx | 97 +++++++++++++++++++++++++++++++ docs/references/index.mdx | 7 +-- sidebars.js | 1 + 3 files changed, 99 insertions(+), 6 deletions(-) create mode 100644 docs/references/api-reference.mdx diff --git a/docs/references/api-reference.mdx b/docs/references/api-reference.mdx new file mode 100644 index 0000000000..5f31f57f6e --- /dev/null +++ b/docs/references/api-reference.mdx @@ -0,0 +1,97 @@ +--- +id: api-reference +title: API reference +sidebar_label: API reference +description: Links to all Temporal SDK API references for Go, Java, Python, TypeScript, .NET, PHP, and Ruby. +keywords: + - api reference + - sdk api + - go api + - java api + - python api + - typescript api + - dotnet api + - php api + - ruby api +tags: + - Reference + - SDK +--- + +# API reference + +Complete API documentation for all Temporal SDKs and server APIs. + +## SDK API References + +
+ +
+

Go SDK API

+

Complete Go SDK API documentation on pkg.go.dev with all packages, types, and methods.

+
+ + + +
+

Java SDK API

+

Complete Java SDK API documentation on javadoc.io with all classes, interfaces, and annotations.

+
+ + + +
+

PHP SDK API

+

Complete PHP SDK API documentation with all namespaces, classes, and interfaces.

+
+ + + +
+

Python SDK API

+

Complete Python SDK API documentation with all modules, classes, and functions.

+
+ + + +
+

Ruby SDK API

+

Complete Ruby SDK API documentation with all modules, classes, and methods.

+
+ + + +
+

TypeScript SDK API

+

Complete TypeScript SDK API documentation with all interfaces, types, and namespaces.

+
+ + + +
+

.NET SDK API

+

Complete .NET SDK API documentation with all namespaces, classes, and methods.

+
+ +
+ +## Server API References + +
+ +
+

Server Frontend API

+

gRPC API reference used by Client and Worker SDKs to communicate with Temporal Server.

+
+ +
+ +## Need Help? + +If you're looking for specific functionality: + +1. **Start with the SDK developer guides** in the [Develop section](/develop) +2. **Use the API reference** for detailed method signatures and parameters +3. **Check the examples** in our [sample applications](https://github.com/temporalio/samples-go) repositories + +For questions about specific APIs, use the **Ask AI** button in the top navigation for instant answers, connect our [Model Context Protocol server](/with-ai) to Claude and other AI tools for real-time documentation access, or visit our [Community Forum](https://community.temporal.io/) and [Discord](https://temporal.io/discord) for community support. diff --git a/docs/references/index.mdx b/docs/references/index.mdx index 0c9eba4556..059b86cd57 100644 --- a/docs/references/index.mdx +++ b/docs/references/index.mdx @@ -9,6 +9,7 @@ tags: - Reference --- +- [API reference](/references/api-reference) - [SDK metrics reference](/references/sdk-metrics) - [Commands reference](/references/commands) - [Events reference](/references/events) @@ -16,10 +17,4 @@ tags: - [Temporal Service configuration reference](/references/configuration) - [Temporal Web UI configuration reference](/references/web-ui-configuration) - [Temporal Cloud Operation reference](/references/operation-list) -- [Go SDK API reference](https://pkg.go.dev/go.temporal.io/sdk) -- [Java SDK API reference](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/index.html) -- [Python SDK API reference](https://python.temporal.io/) -- [TypeScript SDK API reference](https://typescript.temporal.io) -- [.NET SDK API reference](https://dotnet.temporal.io/api/) -- [PHP SDK API reference](https://php.temporal.io/namespaces/temporal.html) - [Glossary](/glossary) diff --git a/sidebars.js b/sidebars.js index 8e4e5eedd4..48dd0fc4c0 100644 --- a/sidebars.js +++ b/sidebars.js @@ -609,6 +609,7 @@ module.exports = { id: 'references/index', }, items: [ + 'references/api-reference', 'references/cluster-metrics', 'references/commands', 'references/configuration', From 307e22cf1df4c4090fb37d7fdc432784bdb79e66 Mon Sep 17 00:00:00 2001 From: Jwahir Sundai Date: Tue, 17 Mar 2026 17:19:22 -0500 Subject: [PATCH 2/4] Refine API reference description and help section Updated description for clarity and removed redundant help section. --- docs/references/api-reference.mdx | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/references/api-reference.mdx b/docs/references/api-reference.mdx index 5f31f57f6e..0e826e38ad 100644 --- a/docs/references/api-reference.mdx +++ b/docs/references/api-reference.mdx @@ -2,7 +2,7 @@ id: api-reference title: API reference sidebar_label: API reference -description: Links to all Temporal SDK API references for Go, Java, Python, TypeScript, .NET, PHP, and Ruby. +description: Includes links to all Temporal SDK API references for Go, Java, Python, TypeScript, .NET, PHP, and Ruby. keywords: - api reference - sdk api @@ -88,10 +88,4 @@ Complete API documentation for all Temporal SDKs and server APIs. ## Need Help? -If you're looking for specific functionality: - -1. **Start with the SDK developer guides** in the [Develop section](/develop) -2. **Use the API reference** for detailed method signatures and parameters -3. **Check the examples** in our [sample applications](https://github.com/temporalio/samples-go) repositories - For questions about specific APIs, use the **Ask AI** button in the top navigation for instant answers, connect our [Model Context Protocol server](/with-ai) to Claude and other AI tools for real-time documentation access, or visit our [Community Forum](https://community.temporal.io/) and [Discord](https://temporal.io/discord) for community support. From bcb1713cb4061654d18d4f10a4075f0c8888fb06 Mon Sep 17 00:00:00 2001 From: Jwahir Sundai Date: Wed, 18 Mar 2026 12:36:09 -0500 Subject: [PATCH 3/4] slack link --- docs/references/api-reference.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/references/api-reference.mdx b/docs/references/api-reference.mdx index 0e826e38ad..8c7395a326 100644 --- a/docs/references/api-reference.mdx +++ b/docs/references/api-reference.mdx @@ -88,4 +88,4 @@ Complete API documentation for all Temporal SDKs and server APIs. ## Need Help? -For questions about specific APIs, use the **Ask AI** button in the top navigation for instant answers, connect our [Model Context Protocol server](/with-ai) to Claude and other AI tools for real-time documentation access, or visit our [Community Forum](https://community.temporal.io/) and [Discord](https://temporal.io/discord) for community support. +For questions about specific APIs, use the **Ask AI** button in the top navigation for instant answers, connect our [Model Context Protocol server](/with-ai) to AI tools for real-time documentation access, or visit our [Community Forum](https://community.temporal.io/) and [Slack](https://temporal.io/slack) for community support. From 92f6810236531f0f57681277ff278f3a68123997 Mon Sep 17 00:00:00 2001 From: Jwahir Sundai Date: Tue, 12 May 2026 12:15:27 -0700 Subject: [PATCH 4/4] fix: address PR review comments on api-reference page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Extract pattern-grid/pattern-card markup into reusable PatternCards component - Fix broken /references/server-frontend-api-reference link → /self-hosted-guide/server-frontend-api-reference - Update security.mdx to use PatternCards, removing inline duplicate HTML and dead + diff --git a/src/components/PatternCards.tsx b/src/components/PatternCards.tsx new file mode 100644 index 0000000000..8ed2298001 --- /dev/null +++ b/src/components/PatternCards.tsx @@ -0,0 +1,32 @@ +import React from 'react'; + +type PatternCardItem = { + href: string; + title: string; + description: string; + external?: boolean; +}; + +type PatternCardsProps = { + items: PatternCardItem[]; +}; + +export default function PatternCards({ items }: PatternCardsProps) { + return ( +
+ {items.map((item) => ( + +
+

{item.title}

+

{item.description}

+
+ + ))} +
+ ); +}