Change .get('/post') as it’s confusing (#1175)

* Change .get('/post') as it’s confusing

Changed /post to /blogpost

* Update docs deps

Author: drwpow

docs/package.json

@@ -9,22 +9,22 @@
     "update-contributors": "node scripts/update-contributors.js"
   },
   "dependencies": {
-    "@algolia/client-search": "^4.17.0",
-    "@astrojs/preact": "^2.2.0",
-    "@astrojs/react": "^2.2.0",
-    "@docsearch/css": "^3.3.5",
-    "@docsearch/react": "^3.3.5",
-    "@types/react": "^18.2.6",
-    "@types/react-dom": "^18.2.4",
-    "astro": "^2.5.4",
-    "preact": "^10.15.0",
+    "@algolia/client-search": "^4.17.2",
+    "@astrojs/preact": "^2.2.1",
+    "@astrojs/react": "^2.2.1",
+    "@docsearch/css": "^3.5.1",
+    "@docsearch/react": "^3.5.1",
+    "@types/react": "^18.2.12",
+    "@types/react-dom": "^18.2.5",
+    "astro": "^2.6.4",
+    "preact": "^10.15.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "sass": "^1.62.1"
+    "sass": "^1.63.4"
   },
   "devDependencies": {
-    "@astrojs/sitemap": "^1.3.1",
-    "@types/node": "^20.2.3",
+    "@astrojs/sitemap": "^1.3.3",
+    "@types/node": "^20.3.1",
     "html-escaper": "^3.0.3",
     "typescript": "^5.1.3"
   }

docs/src/content/docs/openapi-fetch/api.md

@@ -47,7 +47,7 @@ import { paths } from "./v1"; // generated from openapi-typescript
 
 const { get, post } = createClient<paths>({ baseUrl: "https://myapi.dev/v1/" });
 
-const { data, error } = await get("/post/{post_id}", {
+const { data, error } = await get("/blogposts/{post_id}", {
   params: {
     path: { post_id: "my-post" },
     query: { version: 2 },

docs/src/content/docs/openapi-fetch/index.md

@@ -22,15 +22,15 @@ import { paths } from "./v1"; // generated from openapi-typescript
 const { get, post } = createClient<paths>({ baseUrl: "https://myapi.dev/v1/" });
 
 // Type-checked request
-await post("/create-post", {
+await put("/blogposts", {
   body: {
     title: "My New Post",
     // ❌ Property 'publish_date' is missing in type …
   },
 });
 
 // Type-checked response
-const { data, error } = await get("/post/my-blog-post");
+const { data, error } = await get("/blogposts/my-blog-post");
 
 console.log(data.title); // ❌ 'data' is possibly 'undefined'
 console.log(error.message); // ❌ 'error' is possibly 'undefined'
@@ -85,24 +85,22 @@ Using **openapi-fetch** is as easy as reading your schema! For example, given th
 
 ![OpenAPI schema example](/assets/openapi-schema.png)
 
-Here’s how you’d fetch `/post/{post_id}` and `/create-post`:
+Here’s how you’d fetch GET `/blogposts/{post_id}` and POST `/blogposts`:
 
 ```ts
 import createClient from "openapi-fetch";
 import { paths } from "./v1";
 
 const { get, post } = createClient<paths>({ baseUrl: "https://myapi.dev/v1/" });
 
-// GET /post/{post_id}
-const { data, error } = await get("/post/{post_id}", {
+const { data, error } = await get("/blogposts/{post_id}", {
   params: {
     path: { post_id: "my-post" },
     query: { version: 2 },
   },
 });
 
-// POST /create-post
-const { data, error } = await post("/create-post", {
+const { data, error } = await post("/blogposts", {
   body: {
     title: "New Post",
     body: "<p>New post body</p>",
@@ -113,13 +111,13 @@ const { data, error } = await post("/create-post", {
 
 ### Pathname
 
-The pathname of `get()`, `put()`, `post()`, etc. **must match your schema literally.** Note in the example, the URL is `/post/{post_id}`. This library will replace all `path` params for you (so they can be typechecked)
+The pathname of `get()`, `put()`, `post()`, etc. **must match your schema literally.** Note in the example, the URL is `/blogposts/{post_id}`. This library will replace all `path` params for you (so they can be typechecked)
 
 > ✨ **Tip**
 >
 > openapi-fetch infers types from the URL. Prefer static string values over dynamic runtime values, e.g.:
 >
-> - ✅ `"/post/{post_id}"`
+> - ✅ `"/blogposts/{post_id}"`
 > - ❌ `[...pathParts].join("/") + "{post_id}"`
 
 ### Request

packages/openapi-fetch/README.md

@@ -25,7 +25,7 @@ await post("/create-post", {
 });
 
 // Type-checked response
-const { data, error } = await get("/post/my-blog-post");
+const { data, error } = await get("/blogposts/my-blog-post");
 
 console.log(data.title); // ❌ 'data' is possibly 'undefined'
 console.log(error.message); // ❌ 'error' is possibly 'undefined'
@@ -80,24 +80,22 @@ Using **openapi-fetch** is as easy as reading your schema! For example, given th
 
 ![OpenAPI schema example](../../../docs/public/assets/openapi-schema.png)
 
-Here’s how you’d fetch `/post/{post_id}` and `/create-post`:
+Here’s how you’d fetch GET `/blogpost/{post_id}` and POST `/blogposts`:
 
 ```ts
 import createClient from "openapi-fetch";
 import { paths } from "./v1";
 
 const { get, post } = createClient<paths>({ baseUrl: "https://myapi.dev/v1/" });
 
-// GET /post/{post_id}
-const { data, error } = await get("/post/{post_id}", {
+const { data, error } = await get("/blogposts/{post_id}", {
   params: {
     path: { post_id: "my-post" },
     query: { version: 2 },
   },
 });
 
-// POST /create-post
-const { data, error } = await post("/create-post", {
+const { data, error } = await post("/blogposts", {
   body: {
     title: "New Post",
     body: "<p>New post body</p>",
@@ -108,13 +106,13 @@ const { data, error } = await post("/create-post", {
 
 ### Pathname
 
-The pathname of `get()`, `put()`, `post()`, etc. **must match your schema literally.** Note in the example, the URL is `/post/{post_id}`. This library will replace all `path` params for you (so they can be typechecked)
+The pathname of `get()`, `put()`, `post()`, etc. **must match your schema literally.** Note in the example, the URL is `/blogposts/{post_id}`. This library will replace all `path` params for you (so they can be typechecked)
 
 > ✨ **Tip**
 >
 > openapi-fetch infers types from the URL. Prefer static string values over dynamic runtime values, e.g.:
 >
-> - ✅ `"/post/{post_id}"`
+> - ✅ `"/blogposts/{post_id}"`
 > - ❌ `[...pathParts].join("/") + "{post_id}"`
 
 ### Request