Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions docs/references/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
id: api-reference
title: API reference
sidebar_label: API reference
description: Includes 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
---

import PatternCards from '@site/src/components/PatternCards';

# API reference

Complete API documentation for all Temporal SDKs and server APIs.

## SDK API References

<PatternCards items={[
{
href: "https://pkg.go.dev/go.temporal.io/sdk",
title: "Go SDK API",
description: "Complete Go SDK API documentation on pkg.go.dev with all packages, types, and methods.",
external: true,
},
{
href: "https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/index.html",
title: "Java SDK API",
description: "Complete Java SDK API documentation on javadoc.io with all classes, interfaces, and annotations.",
external: true,
},
{
href: "https://php.temporal.io/namespaces/temporal.html",
title: "PHP SDK API",
description: "Complete PHP SDK API documentation with all namespaces, classes, and interfaces.",
external: true,
},
{
href: "https://python.temporal.io/",
title: "Python SDK API",
description: "Complete Python SDK API documentation with all modules, classes, and functions.",
external: true,
},
{
href: "https://ruby.temporal.io/",
title: "Ruby SDK API",
description: "Complete Ruby SDK API documentation with all modules, classes, and methods.",
external: true,
},
{
href: "https://typescript.temporal.io",
title: "TypeScript SDK API",
description: "Complete TypeScript SDK API documentation with all interfaces, types, and namespaces.",
external: true,
},
{
href: "https://dotnet.temporal.io/api/",
title: ".NET SDK API",
description: "Complete .NET SDK API documentation with all namespaces, classes, and methods.",
external: true,
},
]} />

## Server API References

<PatternCards items={[
{
href: "/self-hosted-guide/server-frontend-api-reference",
title: "Server Frontend API",
description: "gRPC API reference used by Client and Worker SDKs to communicate with Temporal Server.",
},
]} />

## 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 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.
7 changes: 1 addition & 6 deletions docs/references/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,12 @@ tags:
- Reference
---

- [API reference](/references/api-reference)
- [SDK metrics reference](/references/sdk-metrics)
- [Commands reference](/references/commands)
- [Events reference](/references/events)
- [Web UI environment variables reference](/references/web-ui-environment-variables)
- [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)
158 changes: 26 additions & 132 deletions docs/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,137 +11,31 @@ tags:
- Security
---

Find security information for your Temporal deployment, whether you're using Temporal Cloud or self-hosting.

<div className="pattern-grid">
<a href="https://trust.temporal.io" className="pattern-card">
<div className="pattern-content">
<h3>Company Security</h3>
<p>Learn about Temporal Technologies' general security practices, compliance certifications, and organizational security measures.</p>
</div>
</a>

<a href="/cloud/security" className="pattern-card">
<div className="pattern-content">
<h3>Temporal Cloud Security</h3>
<p>Explore the security features of our SaaS offering, including mTLS, end-to-end encryption, and enterprise compliance.</p>
</div>
</a>

<a href="/self-hosted-guide/security" className="pattern-card">
<div className="pattern-content">
<h3>Self-Hosted Security</h3>
<p>Discover how to deploy and secure your own Temporal Platform infrastructure with production-ready best practices.</p>
</div>
</a>


<a href="https://temporal.io/pages/cloud-security-white-paper" className="pattern-card">
<div className="pattern-content">
<h3>Temporal Cloud Security Whitepaper</h3>
<p>Learn how Temporal Cloud provides provable security by design - orchestrating encrypted workflows without ever accessing your sensitive data.</p>
</div>
</a>
</div>



<style jsx>{`
.security-cards-container {
margin: 2rem 0;
}

.security-cards-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
gap: 2rem;
margin-top: 2rem;
}

.security-card {
background: linear-gradient(135deg, #ffffff 0%, #fafbfc 100%);
border: 1px solid #e1e8ed;
border-radius: 12px;
padding: 2rem;
transition: all 0.3s ease;
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.04);
position: relative;
overflow: hidden;
}
import PatternCards from '@site/src/components/PatternCards';

.security-card::before {
content: '';
position: absolute;
top: 0;
left: 0;
right: 0;
height: 4px;
background: linear-gradient(90deg, #444ce7 0%, #b664ff 100%);
}

.security-card:hover {
transform: translateY(-4px);
box-shadow: 0 8px 24px rgba(68, 76, 231, 0.12);
border-color: #444ce7;
}

.security-card-header h3 {
margin: 0 0 0.5rem 0;
font-size: 1.375rem;
font-weight: 600;
color: #1a1b23;
line-height: 1.3;
}

.security-card-divider {
width: 40px;
height: 3px;
background: linear-gradient(90deg, #444ce7 0%, #b664ff 100%);
border-radius: 2px;
margin-bottom: 1.5rem;
}

.security-card-body p {
color: #5d6b7d;
line-height: 1.6;
margin-bottom: 1.5rem;
font-size: 0.95rem;
}

.security-card-button {
display: inline-flex;
align-items: center;
gap: 0.5rem;
color: #444ce7;
text-decoration: none;
font-weight: 500;
font-size: 0.95rem;
transition: all 0.2s ease;
padding: 0.5rem 0;
}

.security-card-button:hover {
color: #3730a3;
text-decoration: none;
transform: translateX(2px);
}

.security-card-button svg {
transition: transform 0.2s ease;
}

.security-card-button:hover svg {
transform: translateX(2px);
}

@media (max-width: 768px) {
.security-cards-grid {
grid-template-columns: 1fr;
gap: 1.5rem;
}
Find security information for your Temporal deployment, whether you're using Temporal Cloud or self-hosting.

.security-card {
padding: 1.5rem;
}
}
`}</style>
<PatternCards items={[
{
href: "https://trust.temporal.io",
title: "Company Security",
description: "Learn about Temporal Technologies' general security practices, compliance certifications, and organizational security measures.",
external: true,
},
{
href: "/cloud/security",
title: "Temporal Cloud Security",
description: "Explore the security features of our SaaS offering, including mTLS, end-to-end encryption, and enterprise compliance.",
},
{
href: "/self-hosted-guide/security",
title: "Self-Hosted Security",
description: "Discover how to deploy and secure your own Temporal Platform infrastructure with production-ready best practices.",
},
{
href: "https://temporal.io/pages/cloud-security-white-paper",
title: "Temporal Cloud Security Whitepaper",
description: "Learn how Temporal Cloud provides provable security by design - orchestrating encrypted workflows without ever accessing your sensitive data.",
external: true,
},
]} />
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1375,6 +1375,7 @@ module.exports = {
id: 'references/index',
},
items: [
'references/api-reference',
'references/cluster-metrics',
'references/commands',
'references/configuration',
Expand Down
32 changes: 32 additions & 0 deletions src/components/PatternCards.tsx
Original file line number Diff line number Diff line change
@@ -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 (
<div className="pattern-grid">
{items.map((item) => (
<a
key={item.href}
href={item.href}
className="pattern-card"
{...(item.external ? { target: '_blank', rel: 'noopener noreferrer' } : {})}
>
<div className="pattern-content">
<h3>{item.title}</h3>
<p>{item.description}</p>
</div>
</a>
))}
</div>
);
}
Loading