feat: add support for title and summary for the v3 spec (#1191)

Author: AayushSaini101

.changeset/pretty-owls-draw.md

@@ -0,0 +1,5 @@
+---
+"@asyncapi/parser": patch
+---
+
+feat: add support for title and summary for the v3 spec

packages/parser/src/spec-types/v3.ts

@@ -44,6 +44,8 @@ export interface ServerObject extends SpecificationExtensions {
   protocol: string;
   pathname?: string;
   protocolVersion?: string;
+  title?: string;
+  summary?: string;
   description?: string;
   variables?: Record<string, ServerVariableObject | ReferenceObject>;
   security?: Array<SecuritySchemeObject | ReferenceObject>;

packages/parser/test/models/v3/asyncapi.spec.ts

@@ -245,6 +245,26 @@ describe('AsyncAPIDocument model', function() {
       const d = new AsyncAPIDocument(doc);
       expect(d.allServers()).toBeInstanceOf(Servers);
     });
+
+    it('should expose server title and summary', function() {
+      const doc = serializeInput<v3.AsyncAPIObject>({
+        servers: {
+          production: {
+            host: 'example.com',
+            protocol: 'https',
+            title: 'Production Server',
+            summary: 'Production environment server',
+          },
+        },
+      });
+      const d = new AsyncAPIDocument(doc);
+      const server = d.allServers().all()[0];
+      expect(server.id()).toEqual('production');
+      expect(server.hasTitle()).toEqual(true);
+      expect(server.title()).toEqual('Production Server');
+      expect(server.hasSummary()).toEqual(true);
+      expect(server.summary()).toEqual('Production environment server');
+    });
   });
 
   describe('.allChannels()', function() {

packages/parser/test/models/v3/server.spec.ts

@@ -33,6 +33,36 @@ const docItem = new Server(doc.production, { asyncapi: {} as any, pointer: '', i
 const emptyItem = new Server(serializeInput<v3.ServerObject>({}), { asyncapi: {} as any, pointer: '', id: '' });
 
 describe('Server Model', function () {
+  describe('.title() and .summary()', function () {
+    it('should return title and summary from ServerObject', function () {
+      const doc = serializeInput<v3.ServerObject>({
+        host: 'example.com',
+        protocol: 'https',
+        title: 'Production Server',
+        summary: 'Production environment server',
+      });
+      const d = new Server(doc, { asyncapi: {} as any, pointer: '/servers/production', id: 'production' });
+      expect(d.hasTitle()).toEqual(true);
+      expect(d.title()).toEqual('Production Server');
+      expect(d.hasSummary()).toEqual(true);
+      expect(d.summary()).toEqual('Production environment server');
+      expect(d.json().title).toEqual('Production Server');
+      expect(d.json().summary).toEqual('Production environment server');
+    });
+
+    it('should return false and undefined when title and summary are absent', function () {
+      const doc = serializeInput<v3.ServerObject>({
+        host: 'example.com',
+        protocol: 'https',
+      });
+      const d = new Server(doc, { asyncapi: {} as any, pointer: '/servers/production', id: 'production' });
+      expect(d.hasTitle()).toEqual(false);
+      expect(d.title()).toBeUndefined();
+      expect(d.hasSummary()).toEqual(false);
+      expect(d.summary()).toBeUndefined();
+    });
+  });
+
   describe('.id()', function () {
     it('should return name if present', function () {
       expect(docItem.id()).toEqual('production');

packages/parser/test/parse.spec.ts

@@ -437,6 +437,31 @@ describe('parse()', function () {
     expect(filterLastVersionDiagnostics(diagnostics).length === 0).toEqual(true);
   });
 
+  it('should return server title and summary from allServers()', async function () {
+    const { document, diagnostics } = await parser.parse(`
+asyncapi: 3.0.0
+info:
+  title: API
+  version: 1.0.0
+servers:
+  production:
+    host: example.com
+    protocol: https
+    title: Production Server
+    summary: Production environment server
+channels: {}
+`);
+
+    expect(document).toBeDefined();
+    expect(filterLastVersionDiagnostics(diagnostics).length === 0).toEqual(true);
+    const server = document!.allServers().all()[0];
+    expect(server.id()).toEqual('production');
+    expect(server.hasTitle()).toEqual(true);
+    expect(server.title()).toEqual('Production Server');
+    expect(server.hasSummary()).toEqual(true);
+    expect(server.summary()).toEqual('Production environment server');
+  });
+
   it('should not parse invalid v3 YAML document and give error in line 153 (#936)', async function () {
     const documentRaw = `asyncapi: 3.0.0
 info: