Skip to content
Open
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
15 changes: 15 additions & 0 deletions claude.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,21 @@ Always write "frontend" and "backend" as single words.

Don't give "internet" an initial capital unless it appears at the start of a sentence.

#### OpenAPI description document vs OpenAPI specification

"The OpenAPI Specification" (capitalized, often abbreviated OAS) refers to the
standard itself, published by the OpenAPI Initiative.

A YAML or JSON document that describes an API and conforms to the standard is
an "OpenAPI description" or "OpenAPI description document", not a "spec" or
"specification".

- ❌ Upload your OpenAPI spec.
- ❌ Generate an SDK from your OpenAPI specification.
- ✅ Upload your OpenAPI description document.
- ✅ Generate an SDK from your OpenAPI description.
- ✅ This guide assumes familiarity with the OpenAPI Specification.

#### npm

Always write "npm" in lowercase. Never capitalize as "NPM" or treat it as an acronym. See [npm branding guidelines](https://docs.npmjs.com/policies/logos-and-usage).
Expand Down
6 changes: 3 additions & 3 deletions openapi/frameworks/elysia.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -770,14 +770,14 @@ You can add multiple `servers` to define different environments or versions. Thi

## Adding retries to your SDK with `x-speakeasy-retries`

[OpenAPI document extensions](https://www.speakeasy.com/openapi/extensions) allow us to add vendor-specific functionality to an OpenAPI document.
[OpenAPI extensions](/openapi/extensions) allow us to add vendor-specific functionality to an OpenAPI document.

- Extension fields must be prefixed with `x-`.
- Speakeasy uses extensions that start with `x-speakeasy-`.

Speakeasy gives you fine-tuned control over the Speakeasy SDK via its [range of Speakeasy extensions](https://www.speakeasy.com/docs/speakeasy-extensions), which you can use to modify retries, pagination, error handling, and other advanced SDK features.
Speakeasy gives you fine-tuned control over the Speakeasy SDK via its [range of Speakeasy extensions](/docs/speakeasy-extensions), which you can use to modify retries, pagination, error handling, and other advanced SDK features.

Let's add a Speakeasy extension that adds retries to requests from Speakeasy SDKs by adding a top-level `x-speakeasy-retries` schema to the OpenAPI document. We can also override the retry strategy per operation.
Let's add a Speakeasy extension that adds [retries](/docs/sdks/customize/runtime/retries/) to requests from Speakeasy SDKs by adding a top-level `x-speakeasy-retries` schema to the OpenAPI document. We can also override the retry strategy per operation.

### Adding global retries

Expand Down
Loading
Loading