Skip to content

Commit f940fc7

Browse files
committed
claude: consistently talk about spec vs description
1 parent 083349a commit f940fc7

2 files changed

Lines changed: 20 additions & 5 deletions

File tree

claude.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,21 @@ Always write "frontend" and "backend" as single words.
329329

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

332+
#### OpenAPI description document vs OpenAPI specification
333+
334+
"The OpenAPI Specification" (capitalized, often abbreviated OAS) refers to the
335+
standard itself, published by the OpenAPI Initiative.
336+
337+
A YAML or JSON document that describes an API and conforms to the standard is
338+
an "OpenAPI description" or "OpenAPI description document", not a "spec" or
339+
"specification".
340+
341+
- ❌ Upload your OpenAPI spec.
342+
- ❌ Generate an SDK from your OpenAPI specification.
343+
- ✅ Upload your OpenAPI description document.
344+
- ✅ Generate an SDK from your OpenAPI description.
345+
- ✅ This guide assumes familiarity with the OpenAPI Specification.
346+
332347
#### npm
333348

334349
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).

openapi/frameworks/trpc.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: How To Generate an OpenAPI Spec With tRPC
2+
title: How To Generate an OpenAPI With tRPC
33
description: "How to use tRPC to create an OpenAPI spec and create an SDK for it with Speakeasy."
44
---
55

66
import { Callout } from "@/mdx/components";
77

8-
# How to generate an OpenAPI/Swagger spec with tRPC
8+
# How to generate an OpenAPI/Swagger with tRPC
99

1010
In this tutorial, we'll explore how to generate an OpenAPI document for our [tRPC](https://trpc.io/) API, and then we'll use this document to create an SDK using Speakeasy.
1111

1212
Here's what we'll cover:
1313

1414
1. Adding `trpc-openapi` to a tRPC project.
15-
2. Generating an OpenAPI specification using `trpc-openapi`.
16-
3. Improving the generated OpenAPI specification for better downstream SDK generation.
15+
2. Generating an OpenAPI document using `trpc-openapi`.
16+
3. Improving the generated OpenAPI document for better downstream SDK generation.
1717
4. Using the Speakeasy CLI to create an SDK based on the generated OpenAPI specification.
1818
5. Using the Speakeasy OpenAPI extensions to improve created SDKs.
1919
6. Automating this process as part of a CI/CD pipeline.
@@ -27,7 +27,7 @@ Here's what we'll cover:
2727

2828
tRPC does not natively export OpenAPI documents, but the [`trpc-openapi`](https://github.com/jlalmes/trpc-openapi/) package adds this functionality. We'll start this tutorial by adding `trpc-openapi` to a project, and then we'll add a script to generate an OpenAPI schema and save it as a file.
2929

30-
The quality of your OpenAPI specification will ultimately determine the quality of created SDKs and documentation, so we'll dive into ways you can improve the generated specification.
30+
The quality of the OpenAPI specification will ultimately determine the quality of created SDKs and documentation, so we'll dive into ways you can improve the generated specification.
3131

3232
With our new and improved OpenAPI specification in hand, we'll take a look at how to create SDKs using Speakeasy.
3333

0 commit comments

Comments
 (0)