heroku-agentforce-tutorial-java/api-spec.yaml at main · heroku-examples/heroku-agentforce-tutorial-java · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
openapi: 3.0.1
info:
  title: Agentforce Action
  description: Basic example of an Agentforce Action
  version: 1.0.0

x-sfdc:
  agent:
    topic:
      classificationDescription: This API allows agents to generate name badges for users.
      scope: Your job is to assist users in creating personalized Heroku name badges.
      instructions:
        - If the customer asks to generate a badge, ensure you collect their name.
        - Confirm spelling before generating the badge.
      name: heroku_badge_generation

servers:
  - url: http://localhost:8080
    description: Generated server url

tags:
  - name: Agentforce Action
    description: Basic Agentforce Action example

paths:
  /generateBadge:
    post:
      tags:
        - Agentforce Action
      description: Use this action in response to requests for a Heroku badge with a name on it.
      operationId: generateBadge
      parameters:
        - name: name
          in: query
          description: Name to be placed on the badge.
          required: true
          schema:
            type: string
      responses:
        "200":
          description: This is the Heroku badge the user requested.
          content:
            '*/*':
              schema:
                type: string
      x-sfdc:
        agent:
          action:
            publishAsAgentAction: true
            isUserInput: true
            isDisplayable: true
            isPii: true  # Optional, depending on whether the `name` should be considered PII
        heroku:
          authorization:
            externalClientApp: BadgeServiceExternalClientApp
            permissionSet: BadgeServicePermissions

components: {}