Add /user/{id}

Author: andenacitelli

bin/generate.ts

@@ -6,7 +6,7 @@ import {
   OpenAPIRegistry,
   OpenApiGeneratorV31,
 } from "@asteasolutions/zod-to-openapi";
-import { ItemSchema } from "./model.js";
+import { ItemSchema, UserSchema } from "./model.js";
 
 extendZodWithOpenApi(z);
 
@@ -34,6 +34,28 @@ registry.registerPath({
   },
 });
 
+registry.registerPath({
+  method: "get",
+  operationId: "getUser",
+  path: "/user/{id}.json",
+  summary: "Retrieve a user from the API.",
+  request: {
+    params: z.object({
+      id: z.string(),
+    }),
+  },
+  responses: {
+    200: {
+      description: "Success",
+      content: {
+        "application/json": {
+          schema: UserSchema,
+        },
+      },
+    },
+  },
+});
+
 const generator = new OpenApiGeneratorV31(registry.definitions);
 
 fs.writeFileSync(

bin/model.test.ts

@@ -1,7 +1,7 @@
 import { test, expect } from "vitest";
-import { ItemSchema } from "./model.js";
+import { ItemSchema, UserSchema } from "./model.js";
 
-test("Validate real item", async () => {
+test("Story", async () => {
   const id = 40869877;
   const response = await fetch(
     `https://hacker-news.firebaseio.com/v0/item/${id}.json`
@@ -10,3 +10,13 @@ test("Validate real item", async () => {
   const result = ItemSchema.parse(json);
   expect(result.id).toBe(id);
 });
+
+test("User", async () => {
+  const id = "dang";
+  const response = await fetch(
+    `https://hacker-news.firebaseio.com/v0/user/${id}.json`
+  );
+  const json = await response.json();
+  const result = UserSchema.parse(json);
+  expect(result.id).toBe(id);
+});

bin/model.ts

@@ -50,3 +50,24 @@ export const ItemSchema = z.object({
     .optional()
     .describe("In the case of stories or polls, the total comment count."),
 });
+
+export const UserSchema = z.object({
+  id: z
+    .string()
+    .describe("The user's unique username. Case-sensitive. Required."),
+  created: z
+    .number()
+    .int()
+    .describe(
+      "Creation date of the user, in [Unix Time](http://en.wikipedia.org/wiki/Unix_time)."
+    ),
+  karma: z.number().int().describe("The user's karma."),
+  about: z
+    .string()
+    .optional()
+    .describe("The user's optional self-description. HTML."),
+  submitted: z
+    .array(z.number().int())
+    .optional()
+    .describe("List of the user's stories, polls and comments."),
+});

exports/api.yaml

@@ -87,4 +87,44 @@ paths:
                     description: In the case of stories or polls, the total comment count.
                 required:
                   - id
+  /user/{id}.json:
+    get:
+      operationId: getUser
+      summary: Retrieve a user from the API.
+      parameters:
+        - schema:
+            type: string
+          required: true
+          name: id
+          in: path
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: string
+                    description: The user's unique username. Case-sensitive. Required.
+                  created:
+                    type: integer
+                    description: Creation date of the user, in [Unix
+                      Time](http://en.wikipedia.org/wiki/Unix_time).
+                  karma:
+                    type: integer
+                    description: The user's karma.
+                  about:
+                    type: string
+                    description: The user's optional self-description. HTML.
+                  submitted:
+                    type: array
+                    items:
+                      type: integer
+                    description: List of the user's stories, polls and comments.
+                required:
+                  - id
+                  - created
+                  - karma
 webhooks: {}