W-18562610 [Agent] Implement Agent Flags in Endpoint Summaries

.github/workflows/deployment.yml

@@ -17,48 +17,54 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-20.04]
-        # os: [ubuntu-18.04, ubuntu-20.04]
+        os: [ubuntu-22.04]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 14
-      - uses: microsoft/playwright-github-action@v1
-      - uses: actions/cache@v1
+          node-version: 18
+      - uses: actions/cache@v3
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
       - name: Install dependencies
-        run: npm ci
+        run: |
+          rm -f package-lock.json
+          npm install
       - name: Run tests
         run: npm test
   test_win:
     name: "Windows"
-    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 14
-      - uses: microsoft/playwright-github-action@v1
-      - uses: actions/cache@v1
+          node-version: 18
+      - uses: actions/cache@v3
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-node-
       - name: Install dependencies
-        run: npm ci
+        run: |
+          if (Test-Path package-lock.json) { del package-lock.json }
+          npm install
+        shell: pwsh
       - name: Run tests
         run: npm test
   tag:
     name: "Publishing release"
     if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
-    needs: 
+    needs:
       - test_linux
       - test_win
     runs-on: ubuntu-latest
@@ -69,9 +75,9 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: '14.x'
+          node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
-      - uses: actions/cache@v1
+      - uses: actions/cache@v3
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -98,4 +104,4 @@ jobs:
           prerelease: false
       - run: npm publish --access public
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

demo/agents-api/agents-api.yaml

@@ -0,0 +1,140 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: Hotel Reservations API
+  description: API to manage hotel room bookings, check availability, and apply loyalty benefits.
+x-sfdc:
+  agent:
+    topic:
+      name: Hotel_Room_Reservation
+      classificationDescription: This API allows agents to book, modify, and cancel hotel reservations, as well as apply loyalty upgrades.
+      scope: Your job is to assist customers in booking hotel rooms based on their preferences, loyalty status, and availability. You should also be able to recommend upgrades if the customer qualifies.
+      instructions:
+        - Always check the customer's loyalty status before finalizing the booking.
+        - If the preferred room type is unavailable, suggest alternative options with similar amenities.
+        - Never confirm a reservation without validating payment information.
+        - If the customer qualifies for an upgrade, apply it automatically and notify them.
+paths:
+  /reservations:
+    post:
+      summary: Create a new hotel reservation
+      description: Book a hotel room with specified preferences and apply loyalty upgrades if eligible.
+      operationId: reservationCreate
+      x-sfdc:
+          agent:
+              action:
+                  publishAsAgentAction: true
+      requestBody:
+        required: true
+        description: customer-reservation
+        content:
+          application/json:
+            schema:
+              additionalProperties: false
+              type: object
+              x-sfdc:
+                  agent:
+                      action:
+                          isUserInput: true
+              properties:
+                customerId:
+                  type: string
+                  description: Unique identifier of the customer.
+                checkInDate:
+                  type: string
+                  format: date
+                  description: Date of check-in.
+                checkOutDate:
+                  type: string
+                  format: date
+                  description: Date of check-out.
+                roomType:
+                  type: string
+                  enum: [Standard, Deluxe, Suite]
+                  description: Preferred room type.
+                specialRequests:
+                  type: string
+                  description: Additional requests like pillow type or air freshener choice.
+      responses:
+        '201':
+          description: Reservation successfully created
+          content:
+            application/json:
+              schema:
+                additionalProperties: false
+                type: object
+                x-sfdc:
+                    agent:
+                        action:
+                            isDisplayable: true
+                    privacy:
+                        isPii: true
+                properties:
+                  reservationId:
+                    type: string
+                    description: Unique ID of the created reservation.
+                  upgradeApplied:
+                    type: boolean
+                    description: Indicates if a loyalty-based upgrade was applied.
+                  totalPrice:
+                    type: number
+                    format: float
+                    description: Final price after applying any discounts or upgrades.
+        '400':
+          description: Invalid input provided
+  /reservations/reservationlookup:
+    get:
+      summary: Retrieve reservation details
+      description: Get details of a specific reservation by ID.
+      x-sfdc:
+          agent:
+              action:
+                  publishAsAgentAction: true
+      operationId: reservationRetrieve  
+      requestBody:
+        required: true
+        description: customer-reservation
+        content:
+          application/json:
+            schema:
+              additionalProperties: false
+              type: object
+              x-sfdc:
+                  agent:
+                      action:
+                          isUserInput: true
+              properties:
+                reservationID:
+                  type: string
+                  description: Unique identifier of the reservation.
+      responses:
+        '200':
+          description: Reservation details retrieved successfully
+          content:
+            application/json:
+              schema:
+                additionalProperties: false
+                x-sfdc:
+                    agent:
+                        action:
+                            isDisplayable: true
+                    privacy:
+                        isPii: true 
+                type: object
+                properties:
+                  reservationId:
+                    type: string
+                  customerId:
+                    type: string
+                  roomType:
+                    type: string
+                  checkInDate:
+                    type: string
+                    format: date
+                  checkOutDate:
+                    type: string
+                    format: date
+                  upgradeApplied:
+                    type: boolean
+        '404':
+          description: Reservation not found

demo/apis.json

@@ -17,5 +17,6 @@
     "mime": "application/yaml"
   },
   "APIC-641/APIC-641.yaml": { "type": "OAS 3.0", "mime": "application/yaml" },
-  "APIC-711/APIC-711.raml": "RAML 1.0"
+  "APIC-711/APIC-711.raml": "RAML 1.0",
+  "agents-api/agents-api.yaml": { "type": "OAS 3.0", "mime": "application/yaml" }
 }

demo/index.html

@@ -36,6 +36,8 @@
       --http-method-label-delete-color: #fff;
       --http-method-label-patch-background-color: #811f92;
       --http-method-label-patch-color: #F2F1EF;
+
+      --arc-icon-method-icon-color: #fff;
     }
 
     body.styled.api.dark {

demo/index.js

@@ -13,6 +13,7 @@ class ApiDemo extends ApiDemoPage {
 
   _apiListTemplate() {
     return [
+      ["agents-api", "Agents API"],
       ["google-drive-api", "Google Drive"],
       ["exchange-experience-api", "Exchange xAPI"],
       ["demo-api", "Demo API"],