v1.2.0 🚀 - Add more route metadata support

Author: DZakh

__tests__/Rest_test.res

@@ -1332,3 +1332,72 @@ asyncTest("Sends response without a data", async t => {
   let client = Rest.client(~baseUrl="http://localhost:3000", ~fetcher=args => app->inject(args))
   t->Assert.deepEqual(await client.call(getHeight, ()), ())
 })
+
+asyncTest("Graphql example https://x.com/ChShersh/status/1880968521200603364", async t => {
+  let _issuesQuery = Rest.route(() => {
+    path: "",
+    method: Post,
+    variables: s => {
+      let _ = s.header("Authorization", S.literal(`bearer ${%raw(`process.env.GITHUB_TOKEN`)}`))
+      let _ = s.header("User-Agent", S.literal("chshersh/github-tui"))
+      s.field(
+        "query",
+        S.string->S.transform(
+          _ => {
+            serializer: data =>
+              `query {
+                repository(owner: "${data["owner"]}", name: "${data["repo"]}") {
+                  issues(first: 2, states: [OPEN], orderBy: {field: CREATED_AT, direction: DESC}) {
+                    nodes {
+                      number
+                      title
+                      author {
+                        login
+                      }
+                    }
+                  }
+                }
+              }`,
+          },
+        ),
+      )
+    },
+    responses: [
+      s =>
+        s.data(
+          S.object(
+            s =>
+              s.nested("data").nested("repository").nested("issues").fieldOr(
+                "nodes",
+                S.array(
+                  S.object(
+                    s =>
+                      {
+                        "number": s.field("number", S.int),
+                        "title": s.field("title", S.string),
+                        "author": s.nested("author").field("login", S.string),
+                      },
+                  ),
+                ),
+                [],
+              ),
+          ),
+        ),
+    ],
+  })
+  // let _issues = await Rest.fetch(
+  //   _issuesQuery,
+  //   "https://api.github.com/graphql",
+  //   {
+  //     "owner": "ChShersh",
+  //     "repo": "status",
+  //   },
+  // )
+
+  t->Assert.pass
+
+  // let app = Fastify.make()
+  // app->Fastify.route(getHeight, async () => ())
+  // let client = Rest.client(~baseUrl="http://localhost:3000", ~fetcher=args => app->inject(args))
+  // t->Assert.deepEqual(await client.call(getHeight, ()), ())
+})

__tests__/Swagger_test.res

@@ -280,6 +280,12 @@ asyncTest("Route with all meta info and deprecated", async t => {
         description: "This is a description",
         summary: "This is a summary",
         deprecated: true,
+        tags: ["Foo", "Bar"],
+        externalDocs: {
+          description: "External docs",
+          url: "https://example.com",
+        },
+        operationId: "getNoop",
         path: "/",
         method: Post,
         variables: _ => (),
@@ -304,6 +310,12 @@ asyncTest("Route with all meta info and deprecated", async t => {
             "deprecated": true,
             "summary": "This is a summary",
             "description": "This is a description",
+            "tags": ["Foo", "Bar"],
+            "externalDocs": {
+              "description": "External docs",
+              "url": "https://example.com",
+            },
+            "operationId": "getNoop",
             "responses": {
               "default": {
                 "description": "Default Response",

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "rescript-rest",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "😴 ReScript RPC-like client, contract, and server implementation for a pure REST API",
   "keywords": [
     "rest",
@@ -35,7 +35,7 @@
     ]
   },
   "dependencies": {
-    "rescript-json-schema": "^7.0.0",
+    "rescript-json-schema": "^7.1.0",
     "rescript-openapi": "^0.4.0"
   },
   "devDependencies": {

package.json

@@ -175,6 +175,9 @@ type routeSchema = {
   summary?: string,
   deprecated?: bool,
   response?: dict<routeResponse>,
+  operationId?: string,
+  tags?: array<string>,
+  externalDocs?: OpenAPI.externalDocumentation,
 }
 
 type routeOptions = {
@@ -238,6 +241,9 @@ let route = (app: t, restRoute: Rest.route<'request, 'response>, fn) => {
       description: ?definition.description,
       summary: ?definition.summary,
       deprecated: ?definition.deprecated,
+      tags: ?definition.tags,
+      operationId: ?definition.operationId,
+      externalDocs: ?definition.externalDocs,
       response: routeSchemaResponses,
     }
     let routeOptions = {

src/Fastify.res

@@ -242,6 +242,9 @@ type definition<'variables, 'response> = {
   summary?: string,
   description?: string,
   deprecated?: bool,
+  operationId?: string,
+  tags?: array<string>,
+  externalDocs?: OpenAPI.externalDocumentation,
 }
 
 type routeParams<'variables, 'response> = {

src/Fastify.res.js

@@ -134,6 +134,9 @@ type definition<'variables, 'response> = {
   summary?: string,
   description?: string,
   deprecated?: bool,
+  operationId?: string,
+  tags?: array<string>,
+  externalDocs?: OpenAPI.externalDocumentation,
 }
 
 type route<'variables, 'response>