比較バージョン

古いバージョン 2

changes.mady.by.user 平松孝弘 (Unlicensed)

保存しました

次と比較

新しいバージョン 現在

changes.mady.by.user 平松孝弘 (Unlicensed)

保存しました

キー

  • この行は追加されました。
  • この行は削除されました。
  • 書式設定が変更されました。
情報note

現在の最新は、2.0.4 追加更新中になります。

Swagger open api macro
swagger: "2.0"
info:
  description: "WhatYaAPI'sの仕様に基づき、RestAPIのリクエストに対するレスポンスのExampleWhatYaAPIのメッセージリクエストに対するメッセージレスポンスのサンプル\n
  ※APIのみを利用してV2機能(オペレーターと接続・会話）を利用する場合、別サーバーを必要とします。\n
　この場合、通常の通信方式(Websocket)とは異なり、Webfookを利用した連携接続となります。\n
　別途ご相談ください。"
  version: "12.10.20"
  title: "KeelWhatYa responsesresponse examples"
  termsOfService#termsOfService: "http://swagger.io/terms/"
  contact:
    email: "info@solairo.co.jp"
  license:
    name: "SOLAIRO,Inc."
    url: "http://www.solairo.co.jp"
host#host: "[client]-[appli].bwing[server-no].app"
basePath#basePath: "/whatya/[client code]"
schemes:
- "https"

paths:
  /post/message, /get/messages (text type):
    post:
      tags:
      - "Text Normaltext"
      summary: "※POST, GET same response content."
      description: "※POST, GET same response content."
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: "Text NormalTextのみの応答メッセージ"
          schema:
            $ref: "#/definitions/TextNormalText"
    /get/messages (text type):
    get:
      tags:
      - "Text Normaltext"
      summary: "※POST, GET same response content."
      description: "※POST, GET same response content."
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: "Text NormalTextのみの応答メッセージ"
          schema:
            $ref: "#/definitions/TextNormalText"

  /post/message, /get/messages (link type):
    post:
      tags:
      - "Link"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Link"
  /get/messages (link type):
    get:
      tags:
      - "Link"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Link"

  /post/message, /get/messages (Tel type):
    post:
      tags:
      - "Tel"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Tel"
  /get/messages (Tel type):            
    get:
      tags:
      - "Tel"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Tel" 

  /post/message, /get/messages (Mail type):
    post:
      tags:
      - "Mail"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Mail"
  /get/messages (Mail type):            
    get:
      tags:
      - "Mail"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Mail" 

  /post/message, /get/messages (Image type):
    post:
      tags:
      - "Image"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Image"
            
  /get/messages (Image type):            
    get:
      tags:
      - "Image"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Image"
   /post/message, /get/messages (Item Image Sliders type):
    post:
      tags:
      - "Sliders"
      summary: "※POST, GET same response content."
      description: "keyが文字、valueが画像の組み合わせのスライダー"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/ItemImageSlider"
  /get/messages (Item get:Image Sliders type):
    tagsget:
      tags:
      - "Sliders"
      summary: "※POST, GET same response content."
      description: "keyが文字、valueが画像の組み合わせのスライダー"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/ItemImageSlider"
            
  /post/message, /get/messages (Chips type):
    post:
      tags:
      - "Chips"
      summary: "※POST, GET same response content."
      description: "key, value ともに文字のみのチップ"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/StringStringChip"
  /get/messages (Chips type):            
    get:
      tags:
      - "Chips"
      summary: "※POST, GET same response content."
      description: "key, value ともに文字のみのチップ"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/StringStringChip"

  /post/message, /get/messages (Lists type):
    post:
      tags:
      - "Lists"
      summary: "※POST, GET same response content."
      description: "リスト形式で表示"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Lists"
  /get/messages (Lists gettype):            
    get:
      tags:
      - "Lists"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Lists"
            
  /post/message (Dialog):
    post:
      tags:
      - "Dialog"
      summary: ""
      description: "ダイアログとその内容※【仕様調整中】ダイアログとその内容"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Dialog"
            
  /post/message, /get/messages (Cards type):
    post:
      tags:
      - "Cards"
      summary: "※POST, GET same response content."
      description: "画像の下に説明文を添えるCard型のメッセージタイプ"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Cards"
  /get/messages (Cards type):            
    get:
      tags:
      - "Cards"
      summary: "※POST, GET same response content."
      description: ""
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Cards"
            
  /post/message, /get/messages (Takeover2Op):
    post:
      tags:
      - "Takeover2Op"
      summary: "【別途サーバー準備必要】オペレータ引き継ぎ"
      description: "オペレータに引き継ぐためのメッセージタイプ。\nオペレータに引き継ぐためのメッセージタイプ。\ncontent.message は null または 空文字列でもよい。その場合はメッセージ無しでオペレータに引き継ぐ。"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/137003029/WhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Takeover2Op"
            
  /post/message (Newest):
    post:
      tags:
      - "Newest"
      summary: "最新情報掲載"
      description: "Newest(最新情報)が更新されたことをお知らせするSnackBarを表示する際に使用する。"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/137003029/WhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Newest"
            
  /post/message (Youtube type):
    post:
      tags:
      - "Takeover2OpYoutube"
      summary: "※POST, GET same response content."
      description: "オペレータに引き継ぐためのメッセージタイプ。\nオペレータに引き継ぐためのメッセージタイプ。\ncontent.message は null または 空文字列でもよい。その場合はメッセージ無しでオペレータに引き継ぐ。Youtube動画ストリーミングのメッセージタイプ"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Takeover2OpYoutube"
  /get/messages (Youtube type):           /post/message (Newest):
    postget:
      tags:
      - "NewestYoutube"
      summary: "※POST, GET same response content."
      description: "Newest(最新情報)が更新されたことをお知らせするSnackBarを表示する際に使用する。Youtube動画ストリーミングのメッセージタイプ"
      externalDocs:
        description: "Parameters : See WhatYa's API"
        url: "https://solairo.atlassian.net/wiki/spaces/WHAT1/pages/136019997137003029/APIWhatYa+APIs"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/NewestYoutube"
            
definitions:
  TextNormalText:
    example:
      type: "text"
      content:
        messages : "Hello!! This is Bot answer."
  Link:
    example:
      type: "markdown"
      content:
        messages : "リンクは[こちら](http://www.solairo.co.jp/)"
  Tel:
    example:
      type: "telephone"
      content:
        messages : "サポートセンターへの電話はこちら"
        value: "0120-116-116"
  Mail:
    example:
      type: "mail"
      content:
        messages : "サポートセンターへのメールはこちら"
        value: "support@solairo.co.jp"
  Image:
    example:
      type: "image"
      content:
        messages : "Hello!! This is Bot answer."
        img_url : "https://bucket.com/item/2.png"
        alt : "not image"
  ItemImageSlider:
    example:
      type: "item_image_slider222"
      content:
        messages : "Please choice!"
        sliders:
        - img_url : "https://bucket.com/item/1.png"
          item_name : "item 1 xxxx"
          item_value : "item1"
          price : "¥10000"
          size : "S"
          stock : 1
        - img_url : "https://bucket.com/item/2.png"
          item_name : "item 2 xxxx"
          item_value : "item2"
          price : "¥20000"
          size : "M"
          stock : 2

  StringStringChip:
    example:
      type: "string_string_chip"
      content:
        messages: "Please choose one."
        chips:
        - item_name: "Yes"
          item_value: "Yes"
        - item_name: "No"
          item_value: "No"          
  Lists:
    example:
      type: "list"
      content:
        message: "Please choose something."
        lists:
        - item_name: "Yes"
          item_value: "Yes"
        - item_name: "No"
          item_value: "No" 

  Dialog:
    example:
      type: "dialog"
      content:
        message: "Please choose season."
        chip_accept: "show dialog"
        chip_deny: "deny"
        dialog_items:
        - type: "select"
          label: "your favorite season"
          key: "key1"
          dialog_values:
          - item_name: "春"
            item_value: "Spring"
          - item_name: "夏"
            item_value: "Summer"
          - item_name: "秋"
            item_value: "Autumn"
          - item_name: "冬"
            item_value: "Winter"
        - type: "select"
          label: "your favorite color"
          key: "key2"
          dialog_values:
          - item_name: "赤"
            item_value: "Red"
          - item_name: "青"
            item_value: "Blue"
          - item_name: "黄"
            item_value: "Yellow"
          - item_name: "緑"
            item_value: "Green"          
        - type: "DatePicker"
          label: "...."
  Cards:
    example:
      type: "image_card"
      content:
        messages : "今日のメニュー"
        image: "http://www.image.com/new/content/1"
        text: "メニュー内容"
        link:
          label: "詳細はこちら"
          url: "https://www...."
  Takeover2Op:
    example:
      type: "takeover_to_op"
      content:
        messages : "オペレータに引き継ぎます。"
  Newest:
    example:
      type: "normal"
      update_at: 1574246097042
      content:
        messages : "最新情報だよ"
        value: "LINKAGE-Newest"
  Youtube:
    example:
      type: "youtube"
      content:
        messages : "This is the best movie."
        videoId: "L7lc1UVf-VE"
        autoplay: "true"
externalDocs:
  description: "Find out more about Swagger"
  url: "http://swagger.io"

...