Fill additional information to OpenAPI spec

Information such as API version, license and summary were missing in the generated OpenAPI spec.
pinax-network · May 27, 2024 · 4156c75 · 4156c75
1 parent c7979ed
commit 4156c75
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 5 deletions.
diff --git a/bun.lockb b/bun.lockb
diff --git a/src/typespec/openapi3.tsp b/src/typespec/openapi3.tsp
@@ -1,11 +1,19 @@
 import "@typespec/http";
+import "@typespec/openapi";
 import "./models.tsp";
 
 using TypeSpec.Http;
-
-@service({
-    title: "Antelope Token API",
-})
+using TypeSpec.OpenAPI;
+
+@service({ title: "Antelope Token API" })
+@info({
+    summary: "Tokens information from the Antelope blockchains, powered by Substreams",
+    license: {
+        name: "MIT",
+        url: "https://github.com/pinax-network/antelope-token-api/blob/4f4bf36341b794c0ccf5b7a14fdf810be06462d2/LICENSE"
+    },
+    version: "3.0.0"
+}) // From @typespec/openapi
 namespace AntelopeTokenAPI;
 
 // Error codes adapted from https://github.com/pinax-network/golang-base/blob/develop/response/errors.go

diff --git a/tsp-output/@typespec/openapi3/openapi.json b/tsp-output/@typespec/openapi3/openapi.json
@@ -2,7 +2,12 @@
   "openapi": "3.0.0",
   "info": {
     "title": "Antelope Token API",
-    "version": "0.0.0"
+    "summary": "Tokens information from the Antelope blockchains, powered by Substreams",
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/pinax-network/antelope-token-api/blob/4f4bf36341b794c0ccf5b7a14fdf810be06462d2/LICENSE"
+    },
+    "version": "3.0.0"
   },
   "tags": [
     {