Skip to content

Commit ddba630

Browse files
authored
docs: per page descriptions (#328)
- add per-page descriptions for better cards in slack, etc - regenerate changelog - add keywords
1 parent dfde855 commit ddba630

File tree

20 files changed

+127
-22
lines changed

20 files changed

+127
-22
lines changed

integration-tests/typescript-fetch/src/generate-release-notes.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ async function main() {
4949
const notes = await generateReleaseNotes()
5050
const result = `---
5151
title: Release Notes
52+
description: Changelog of all OpenAPI Code Generator releases, including new features, bug fixes, breaking changes, and upgrade instructions for each version.
5253
---
5354
5455
import { Callout, Steps } from 'nextra/components'

packages/documentation/src/app/getting-started/quick-start/page.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Quick Start
3+
description: A step-by-step guide to installing and using OpenAPI Code Generator with different client and server templates, including TypeSpec support.
34
---
45

56
import {Steps, Tabs} from "nextra/components"

packages/documentation/src/app/getting-started/tips-for-writing-specifications/page.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Tips for writing specifications
3+
description: Best practices and recommendations for writing high-quality OpenAPI specifications that generate better code and are easier to maintain.
34
---
45

56
# Tips for writing a good specification
@@ -82,7 +83,7 @@ Produces something like:
8283
export type Apple = {}
8384
export type Pear = {}
8485
export type Fruit = Apple | Pear
85-
````
86+
```
8687

8788
**Intersection Types**
8889
Using `allOf` of we can combine types / schemas into intersection types. This is often
@@ -107,7 +108,7 @@ Produces something like:
107108
```typescript
108109
export type Profile = {}
109110
export type FullProfile = Profile & {}
110-
````
111+
```
111112

112113
## Use validation constraints where sensible
113114

packages/documentation/src/app/guides/client-templates/typescript-angular/page.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: typescript-angular
3+
description: Generate a strongly-typed Angular client SDK based on the Angular HttpClient with RxJS Observable support for your OpenAPI or TypeSpec definitions.
34
---
45

56
import {Callout, Tabs} from 'nextra/components'

packages/documentation/src/app/guides/client-templates/typescript-axios/page.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: typescript-axios
3+
description: Generate a strongly-typed axios client SDK with typed methods for each endpoint and optional runtime response validation for your OpenAPI or TypeSpec definitions.
34
---
45

56
import {Callout, Tabs} from 'nextra/components'

packages/documentation/src/app/guides/client-templates/typescript-fetch/page.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: typescript-fetch
3+
description: Generate a strongly-typed fetch client SDK with typed methods, timeout support, and optional runtime response validation for your OpenAPI or TypeSpec definitions.
34
---
45

56
import {Callout, Tabs} from 'nextra/components'

packages/documentation/src/app/guides/concepts/authenticated-input-specifications/page.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Authenticated input specifications
3+
description: Learn how to access protected OpenAPI specifications by configuring authentication headers for remote URLs, with examples for Google Cloud IAP proxy and private GitHub repositories.
34
---
45

56
# Authenticated input specifications
@@ -48,7 +49,7 @@ uri like `https://example.com` will send headers on any (`https`) request to tha
4849
such as `https://exmaple.com/some/path/openapi.yaml`
4950

5051
## Tips for generating the JSON
51-
Unfortunately it is a little annoying to formulate in shell scripts, so here's some examples to get you started.
52+
Unfortunately, it is a little annoying to formulate in shell scripts, so here's some examples to get you started.
5253

5354
Typically, in any real use cases the secret values would be coming from other shell variables, eg: storing a
5455
short-lived access token, etc.

packages/documentation/src/app/guides/concepts/enums/page.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Enums
3+
description: Understand how enumerated types are handled in code generation, including the difference between open and closed enums and how to ensure API compatibility when evolving your API.
34
---
45

56
# Enumerated Types
@@ -59,6 +60,7 @@ enum:
5960
```
6061

6162
### Server code (closed enum)
63+
6264
For server templates, we just generate the exact `enum` values, meaning that an error will be raised both
6365
if a client sends us an unknown value, or the server attempts to respond with one.
6466

@@ -122,6 +124,7 @@ This is interesting as it means that our server can start returning new enumerat
122124
updated to explicitly handle them, and it nudges developers to handle the unknown case gracefully.
123125

124126
## Customizing the behavior
127+
125128
There are two ways you can customize this behavior
126129

127130
- Global CLI option `--enum-extensibility <value>`
@@ -130,6 +133,7 @@ There are two ways you can customize this behavior
130133
Where `<value>` is either `open` or `closed`.
131134

132135
Example:
136+
133137
```yaml
134138
type: string
135139
x-enum-extensibility: closed

packages/documentation/src/app/guides/concepts/extract-inline-schemas/page.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Extract inline schemas
3+
description: Learn how to use the extract-inline-schemas feature to generate reusable types and schemas from inline OpenAPI definitions, reducing code duplication and improving maintainability.
34
---
45

56
# Extract inline schemas

packages/documentation/src/app/guides/concepts/servers-object-handling/page.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Guide to servers object handling
3+
description: Understand how the OpenAPI servers object is processed in client SDK templates, including variable substitution, overrides, and typed base paths for flexible API endpoint configuration.
34
---
45

56
import {Callout} from "nextra/components"
@@ -21,6 +22,7 @@ This is fully supported, including placeholder/variable substitution, and overri
2122

2223

2324
## Overview
25+
2426
Consider an example servers block:
2527
```yaml
2628
servers:

0 commit comments

Comments
 (0)