-
Notifications
You must be signed in to change notification settings - Fork 305
api reference page #4302
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jsundai
wants to merge
4
commits into
main
Choose a base branch
from
api-reference-pg
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
api reference page #4302
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| --- | ||
| 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 | ||
| --- | ||
|
|
||
| # API reference | ||
|
|
||
| Complete API documentation for all Temporal SDKs and server APIs. | ||
|
|
||
| ## SDK API References | ||
|
|
||
| <div className="pattern-grid"> | ||
| <a href="https://pkg.go.dev/go.temporal.io/sdk" className="pattern-card" target="_blank" rel="noopener noreferrer"> | ||
| <div className="pattern-content"> | ||
| <h3>Go SDK API</h3> | ||
| <p>Complete Go SDK API documentation on pkg.go.dev with all packages, types, and methods.</p> | ||
| </div> | ||
| </a> | ||
|
|
||
| <a href="https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/index.html" className="pattern-card" target="_blank" rel="noopener noreferrer"> | ||
| <div className="pattern-content"> | ||
| <h3>Java SDK API</h3> | ||
| <p>Complete Java SDK API documentation on javadoc.io with all classes, interfaces, and annotations.</p> | ||
| </div> | ||
| </a> | ||
|
|
||
| <a href="https://php.temporal.io/namespaces/temporal.html" className="pattern-card" target="_blank" rel="noopener noreferrer"> | ||
| <div className="pattern-content"> | ||
| <h3>PHP SDK API</h3> | ||
| <p>Complete PHP SDK API documentation with all namespaces, classes, and interfaces.</p> | ||
| </div> | ||
| </a> | ||
|
|
||
| <a href="https://python.temporal.io/" className="pattern-card" target="_blank" rel="noopener noreferrer"> | ||
| <div className="pattern-content"> | ||
| <h3>Python SDK API</h3> | ||
| <p>Complete Python SDK API documentation with all modules, classes, and functions.</p> | ||
| </div> | ||
| </a> | ||
|
|
||
| <a href="https://ruby.temporal.io/" className="pattern-card" target="_blank" rel="noopener noreferrer"> | ||
| <div className="pattern-content"> | ||
| <h3>Ruby SDK API</h3> | ||
| <p>Complete Ruby SDK API documentation with all modules, classes, and methods.</p> | ||
| </div> | ||
| </a> | ||
|
|
||
| <a href="https://typescript.temporal.io" className="pattern-card" target="_blank" rel="noopener noreferrer"> | ||
| <div className="pattern-content"> | ||
| <h3>TypeScript SDK API</h3> | ||
| <p>Complete TypeScript SDK API documentation with all interfaces, types, and namespaces.</p> | ||
| </div> | ||
| </a> | ||
|
|
||
| <a href="https://dotnet.temporal.io/api/" className="pattern-card" target="_blank" rel="noopener noreferrer"> | ||
| <div className="pattern-content"> | ||
| <h3>.NET SDK API</h3> | ||
| <p>Complete .NET SDK API documentation with all namespaces, classes, and methods.</p> | ||
| </div> | ||
| </a> | ||
| </div> | ||
|
|
||
| ## Server API References | ||
|
|
||
| <div className="pattern-grid"> | ||
| <a href="/references/server-frontend-api-reference" className="pattern-card"> | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This link seems to 404 |
||
| <div className="pattern-content"> | ||
| <h3>Server Frontend API</h3> | ||
| <p>gRPC API reference used by Client and Worker SDKs to communicate with Temporal Server.</p> | ||
| </div> | ||
| </a> | ||
| </div> | ||
|
|
||
| ## 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could these elements be made into components and reused instead of the duplicate code?