Skip to content

Docs update #1494

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

Merged
merged 1 commit into from
Dec 24, 2023
Merged
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
2 changes: 1 addition & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const HOSTNAME = "https://opeanpi-ts.pages.dev";

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "OpenAPI TS",
title: "OpenAPI TypeScript",
description: "Consume OpenAPI 3.0 & 3.1 schemas in TypeScript",
cleanUrls: true,
srcExclude: ["**/*/CONTRIBUTRING.md", "**/*/README.md"],
Expand Down
2 changes: 1 addition & 1 deletion docs/data/contributors.json

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
layout: home

hero:
name: "OpenAPI TS"
tagline: Use OpenAPI 3.0 & 3.1 schemas in TypeScript
name: "OpenAPI TypeScript"
tagline: Convert OpenAPI 3.0/3.1 schemas to TypeScript types and create type-safe fetching.
actions:
- theme: brand
text: Get Started
Expand All @@ -14,10 +14,10 @@ hero:
link: https://github.com/drwpow/openapi-typescript

features:
- title: Platform-agnostic
details: Generate TypeScript types from any OpenAPI schema, no matter how it was generated
- title: Runtime-free static types
details: Achieve type safety with no performance drawbacks
- title: Extremely lightweight
details: Static TypeScript types are runtime-free for maximum performance and minimal client weight.
- title: Type-safe fetch client
details: Validate requests & responses automatically using your OpenAPI schema, and throw TypeScript errors on mismatches.
- title: Built on Redocly CLI
details: Use Redocly’s powerful validation and schema authoring tools while reducing configuration
details: Use Redocly’s powerful validation and schema authoring tools while reducing configuration.
---
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
"update-contributors": "node scripts/update-contributors.js"
},
"devDependencies": {
"vitepress": "1.0.0-rc.31"
"vitepress": "1.0.0-rc.32"
}
}
2 changes: 1 addition & 1 deletion packages/openapi-fetch/examples/react-query/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@
"devDependencies": {
"@vitejs/plugin-react-swc": "^3.5.0",
"typescript": "^5.3.3",
"vite": "^5.0.8"
"vite": "^5.0.10"
}
}
6 changes: 3 additions & 3 deletions packages/openapi-fetch/examples/sveltekit/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
"openapi-typescript": "workspace:^"
},
"devDependencies": {
"@sveltejs/adapter-auto": "^2.1.1",
"@sveltejs/kit": "^1.30.2",
"@sveltejs/adapter-auto": "^3.0.1",
"@sveltejs/kit": "^2.0.6",
"svelte": "^4.2.8",
"svelte-check": "^3.6.2",
"tslib": "^2.6.2",
"typescript": "^5.3.3",
"vite": "^5.0.8"
"vite": "^5.0.10"
}
}
2 changes: 1 addition & 1 deletion packages/openapi-fetch/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"openapi-typescript-fetch": "^1.1.3",
"superagent": "^8.1.2",
"typescript": "^5.3.3",
"vitest": "^0.34.6",
"vitest": "^1.1.0",
"vitest-fetch-mock": "^0.2.2"
}
}
2 changes: 1 addition & 1 deletion packages/openapi-typescript-helpers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@
"test": "tsc --noEmit"
},
"devDependencies": {
"typescript": "^5.3.2"
"typescript": "^5.3.3"
}
}
2 changes: 1 addition & 1 deletion packages/openapi-typescript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,6 @@
"esbuild": "^0.19.9",
"execa": "^7.2.0",
"vite-node": "^1.0.4",
"vitest": "^0.34.6"
"vitest": "^1.1.0"
}
}
Loading