WIP: Add Stainless integration guide #336
Draft
+145
−0
Conversation
This file contains 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
✅ Deploy Preview for bump-content-hub ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
dtmeadows
reviewed
Feb 26, 2025
| date: 2025-02-26 | ||
| --- | ||
|
|
||
| Every developer wants to get up and running with an API as quickly as possible, and that means seeing code examples in their preferred language. With Stainless SDK integration in your bump.sh docs, you can automatically display idiomatic SDK code samples alongside your API reference documentation. |
There was a problem hiding this comment.
Suggested change
| Every developer wants to get up and running with an API as quickly as possible, and that means seeing code examples in their preferred language. With Stainless SDK integration in your bump.sh docs, you can automatically display idiomatic SDK code samples alongside your API reference documentation. | |
| Every developer wants to get up and running with an API as quickly as possible, and that means seeing code examples in their preferred language. With an integration between [Stainless](https://www.stainless.com/) and your bump.sh docs, you can automatically display idiomatic SDK code samples alongside your API reference documentation. |
| 2. Stainless decorates your OpenAPI with code samples for each endpoint | ||
| 3. bump.sh renders these samples in your API reference documentation | ||
|
|
||
| The result is an interactive documentation that shows both raw HTTP requests and language-specific SDK examples developers can copy-paste and |
There was a problem hiding this comment.
Suggested change
| The result is an interactive documentation that shows both raw HTTP requests and language-specific SDK examples developers can copy-paste and | |
| The result is interactive documentation that shows both raw HTTP requests and language-specific SDK examples that developers can copy-paste and |
|
|
||
| Before starting, make sure you have: | ||
|
|
||
| - An account on [Stainless](https://app.stainless.com/) |
There was a problem hiding this comment.
Suggested change
| - An account on [Stainless](https://app.stainless.com/) | |
| - An account on [Stainless](https://app.stainlessapi.com/signup) |
|
|
||
| The Stainless Studio provides an immediate preview of your SDK structure based on your API's resources, endpoints, and models. | ||
|
|
||
|  |
There was a problem hiding this comment.
I might add a callout here to our docs too!
|
|
||
|  | ||
|
|
||
| ### Configure Your SDK Resources |
There was a problem hiding this comment.
I might omit this section and just link to our own getting started guide?
|
|
||
| ## Connecting Stainless with bump.sh | ||
|
|
||
| The most efficient way to keep your SDK in sync with your documentation is through CI/CD automation. |
There was a problem hiding this comment.
I might just link to our own docs here so we don't have to maintain multiple places describing how to set up the github action?
There was a problem hiding this comment.
Oh nvm now I see this has bump step in it!
|
|
||
| This workflow: | ||
|
|
||
| 1. Upload your OpenAPI specification file to Stainless, triggering new builds of your SDKs |
There was a problem hiding this comment.
Suggested change
| 1. Upload your OpenAPI specification file to Stainless, triggering new builds of your SDKs | |
| 1. Uploads your OpenAPI specification file to Stainless, triggering a new update to your SDKs |
| This workflow: | ||
|
|
||
| 1. Upload your OpenAPI specification file to Stainless, triggering new builds of your SDKs | ||
| 2. Deploys the expetend specification file to bump.sh |
There was a problem hiding this comment.
Suggested change
| 2. Deploys the expetend specification file to bump.sh | |
| 2. Deploys the extended specification file to bump.sh |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.