Merge pull request #82 from lifeomic/ep/endpoint-descriptions

fix: include route description as ts comment
lifeomic · Sep 21, 2023 · 21f664f · 21f664f
2 parents 1b72e84 + ede957f
commit 21f664f
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/src/generate-api-types.test.ts b/src/generate-api-types.test.ts
@@ -156,6 +156,7 @@ export const Schema: OneSchema<Endpoints> = {
           Endpoints: {
             'GET /fruits': {
               Name: 'getPosts',
+              Description: 'Fetches an array of all fruits.',
               Request: {},
               Response: {
                 type: 'array',
@@ -171,6 +172,9 @@ export const Schema: OneSchema<Endpoints> = {
 import type { OneSchema } from "@lifeomic/one-schema";
 
 export type Endpoints = {
+  /**
+   * Fetches an array of all fruits.
+   */
   "GET /fruits": {
     Request: unknown;
     PathParams: {};
@@ -220,6 +224,7 @@ export const Schema: OneSchema<Endpoints> = {
   Endpoints: {
     "GET /fruits": {
       Name: "getPosts",
+      Description: "Fetches an array of all fruits.",
       Request: {},
       Response: { type: "array", items: { $ref: "#/definitions/Fruit" } },
     },

diff --git a/src/generate-axios-client.test.ts b/src/generate-axios-client.test.ts
@@ -155,6 +155,13 @@ export type Endpoints = {
       output?: string;
     };
   };
+  /**
+   * This is a long description about a field. It contains lots of very long text. Sometimes the text might be over the desired line length.
+   *
+   * It contains newlines.
+   *
+   * ## It contains markdown.
+   */
   "PUT /posts/:id": {
     Request: {
       message?: string;

diff --git a/src/generate-endpoints.ts b/src/generate-endpoints.ts
@@ -14,11 +14,12 @@ export const generateEndpointTypes = async ({
   Endpoints,
 }: OneSchemaDefinition) => {
   const masterSchema: JSONSchema4 = Object.entries(Endpoints).reduce(
-    (accum, [key, { Request, Response }]) => ({
+    (accum, [key, { Description, Request, Response }]) => ({
       ...accum,
       properties: {
         ...accum.properties,
         [key]: {
+          description: Description,
           type: 'object',
           additionalProperties: false,
           required: ['Request', 'PathParams', 'Response'],