ovp.LucyBot.yml

specifications:
  kaltura:
    - openapi: ./ovp.openapi.json

sitemap:
  hostname: https://developer.kaltura.com

discussionURL: '/discussion/{{slug}}?title={{title}}'

routes:
  /:
    redirect: '/api-docs'

  /api-docs:
    title: Kaltura API Documentation
    for: kaltura
    navigation: operationNavigation
    meta:
      title: "Kaltura VPaaS API Documentation"
      description: "Full documentation for the Kaltura VPaaS API"

  /console:
    ui: console
    for: kaltura
    title: Kaltura API Console
    navigation: operationNavigation
    meta:
      title: "Kaltura VPaaS API Console"
      description: "Make test calls to the Kaltura VPaaS API"

  /workflows:
    ui: workflows
    for: kaltura
    navigation: workflowNavigation
    intro: |
      Interactive workflows on this page will help you dive straight
      into coding the various building blocks of your application.

      Here you will find working code workflows together with detailed
      explanations and documentation references.

      #### What do you want to do today?
    title: Workflows
    icons: offset
    meta:
      title: "Kaltura API Workflows"
      description: "Learn how to work with the Kaltura API using interactive workflows"

  /new-workflow:
    ui: workflow
    for: kaltura
  /preview-workflow:
    ui: workflow
    for: kaltura

  /recipes:
    redirect: '/workflows'
  /recipes/ad_cue_points:
    redirect: '/workflows/Engage_and_Publish/Advertisement_Cue_Points'
  /recipes/analytics:
    redirect: '/workflows/Review_Media_Analytics/Analytics_Reports'
  /recipes/app_tokens:
    redirect: '/workflows/Generate_API_Sessions/App_Token_Authentication'
  /recipes/authentication:
    redirect: '/workflows/Generate_API_Sessions/Authentication'
  /recipes/backend_notifications:
    redirect: '/workflows/Integration_Scheduling_and_Hooks/Backend_and_Email_Notifications'
  /recipes/captions:
    redirect: '/workflows/Enrich_and_Organize_Metadata/Captions'
  /recipes/code_cue_points:
    redirect: '/workflows/Engage_and_Publish/Cue_Points'
  /recipes/dynamic_thumbnails:
    redirect: '/workflows/Engage_and_Publish/Animated_Thumbnails_with_CSS_Stripes'
  /recipes/leaderboard_reports:
    redirect: '/workflows/Integration_Scheduling_and_Hooks/Leaderboard_Reports'
  /recipes/live_broadcast:
    redirect: '/workflows/Live_Stream_and_Broadcast'
  /recipes/metadata:
    redirect: '/workflows/Enrich_and_Organize_Metadata/Working_with_metadata'
  /recipes/player_external_skin_overrides:
    redirect: '/workflows/Engage_and_Publish/Kaltura_Player_External_Skin_Overrides'
  /recipes/player_uiconf:
    redirect: '/workflows/Engage_and_Publish/Player_UI_conf'
  /recipes/quiz:
    redirect: '/workflows/Engage_and_Publish/Quiz'
  /recipes/upload:
    redirect: '/workflows/Ingest_and_Upload_Media'
  /recipes/using_css_states:
    redirect: '/workflows/Engage_and_Publish/Using_CSS_states'
  /recipes/video_search:
    redirect: '/workflows/Search_Discover_and_Personalize/Kaltura_Media_Library_Search'
  /recipes/webvtt_captions:
    redirect: '/workflows/Enrich_and_Organize_Metadata/Serve_WebVTT_Captions'

operationNavigation:
  - title: "Overview"
    markdownFile: ./markdown/overview.md
    discussionURL: null
  - title: "Client Libraries"
    markdownFile: ./markdown/generated/client_libraries.md
    disableEditLink: true
    discussionURL: null
    children:
      - title: "Support Matrix"
        markdownFile: ./markdown/generated/support_matrix.md
        disableEditLink: true
  - title: "XML Schemas"
    markdownFile: ./markdown/schemas.md
    children:
      - title: 'Syndication Feed'
        markdownFile: ./markdown/generated/syndication.md
        disableEditLink: true
        prerender: false
      - title: 'Bulk Upload'
        markdownFile: ./markdown/generated/bulkUploadXml.bulkUploadXML.md
        disableEditLink: true
        prerender: false
      - title: 'Bulk Upload Results'
        markdownFile: ./markdown/generated/bulkUploadXml.bulkUploadResultXML.md
        disableEditLink: true
        prerender: false
      - title: 'Cue Point Serve'
        markdownFile: ./markdown/generated/cuePoint.serveAPI.md
        disableEditLink: true
        prerender: false
      - title: 'Cue Point Ingest'
        markdownFile: ./markdown/generated/cuePoint.ingestAPI.md
        disableEditLink: true
        prerender: false
      - title: 'Drop Folder'
        markdownFile: ./markdown/generated/dropFolderXmlBulkUpload.dropFolderXml.md
        disableEditLink: true
        prerender: false
  - title: "Generate API Sessions"
    children:
      - title: "session"
        tag: "session"
        children:
          - operation: "session.start"
          - operation: "session.end"
          - operation: "session.get"
          - operation: "session.impersonate"
          - operation: "session.impersonateByKs"
          - operation: "session.startWidgetSession"
      - tag: "appToken"
      - operation: 'user.loginByLoginId'
  - title: "Ingest and Upload Media"
    children:
      - tag: "uploadToken"
      - tag: "media"
      - tag: "captionAsset"
      - tag: "captionParams"
      - tag: "thumbAsset"
      - tag: "attachmentAsset"
      - tag: "externalMedia"
      - tag: "upload"
        hidden: true
  - title: "Execute Bulk Ingest and Updates"
    children:
      - operation: "media.bulkUploadAdd"
      - operation: "user.addFromBulkUpload"
      - operation: "category.addFromBulkUpload"
      - operation: "cuePoint.addFromBulk"
      - operation: "categoryEntry.addFromBulkUpload"
      - operation: "categoryUser.addFromBulkUpload"
      - tag: "bulk"
      - tag: "schema"
      - tag: "dropFolder"
      - tag: "dropFolderFile"
      - tag: "virusScanProfile"
        hidden: true
      - tag: "aspera"
        hidden: true
      - tag: "bulkUpload"
        hidden: true
  - title: "Convert and Transcode Media"
    children:
      - tag: "flavorAsset"
      - tag: "flavorParams"
      - tag: "flavorParamsOutput"
      - tag: "conversionProfile"
      - tag: "conversionProfileAssetParams"
      - tag: "mediaInfo"
  - title: "Live Stream and Broadcast"
    children:
      - tag: "liveStream"
  - title: "Enrich and Organize Metadata"
    children:
      - tag: "baseEntry"
      - tag: "category"
      - tag: "categoryEntry"
      - tag: "categoryUser"
      - tag: "metadata"
      - tag: "metadataProfile"
      - tag: "captionAsset"
      - tag: "captionParams"
      - tag: "captionAssetItem"
      - tag: "attachmentAsset"
      - tag: "thumbAsset"
      - tag: "thumbParams"
      - tag: "tag"
  - title: "Search, Discover and Personalize"
    children:
      - operation: "baseEntry.list"
      - tag: "captionAssetItem"
      - tag: "playlist"
      - tag: "like"
      - tag: "shortLink"
      - tag: "tag"
      - tag: "user"
      - tag: "groupUser"
  - title: "Engage and Publish"
    children:
      - tag: "playlist"
      - tag: "thumbnail"
      - tag: "cuePoint"
      - tag: "quiz"
      - tag: "userEntry"
      - tag: "like"
      - tag: "uiConf"
      - tag: "annotation"
        hidden: true
  - title: "Review Media Analytics"
    children:
      - tag: "analytics"
      - tag: "report"
      - tag: "liveReports"
      - tag: "liveStats"
      - tag: "stats"
  - title: "Deliver and Distribute Media"
    children:
      - tag: "playManifest"
      - tag: "syndicationFeed"
      - tag: "entryDistribution"
      - tag: "distributionProfile"
      - tag: "distributionProvider"
      - tag: "deliveryProfile"
        hidden: true
      - tag: "storageProfile"
        hidden: true
  - title: "Secure, Control and Govern"
    children:
      - tag: "partner"
      - tag: "user"
      - tag: "userRole"
      - tag: "groupUser"
      - tag: "accessControlProfile"
      - tag: "categoryEntry"
      - tag: "categoryUser"
      - tag: "permission"
      - tag: "permissionItem"
      - tag: "accessControl"
        hidden: true
      - tag: "adminUser"
        hidden: true
      - tag: "auditTrail"
        hidden: true
  - title: "Optimize API Requests"
    children:
      - tag: "multirequest"
      - tag: "responseProfile"
  - title: "Integration, Scheduling and Hooks"
    children:
      - tag: "eventNotificationTemplate"
      - tag: "scheduledTaskProfile"
      - title: "Scheduling Triggers using iCal"
        markdownFile: ./markdown/scheduling.md
        children:
          - tag: "scheduleEvent"
          - tag: "scheduleEventResource"
          - tag: "scheduleResource"
      - tag: "integration"
      - tag: "businessProcessCase"
      - tag: "notification"
        hidden: true
  - title: "Encrypt and License Content"
    children:
      - tag: "drmLicenseAccess"
      - tag: "drmPolicy"
      - tag: "drmProfile"
      - tag: "playReadyDrm"
      - tag: "widevineDrm"
      - tag: "deliveryProfile"
        hidden: true
  - title: "Manage Documents and Other Assets"
    children:
      - tag: "baseEntry"
      - tag: "data"
      - tag: "documents"
  - title: "Manage and Deliver Apps and Widgets"
    children:
      - tag: "uiConf"
      - tag: "widget"
      - tag: "fileAsset"
      - tag: "captureSpace"
  - title: "Manage Backend and Storage"
    children:
      - tag: "system"
      - tag: "storageProfile"
        hidden: true

workflowNavigation:
  - title: Generate API Sessions
    icon: assets/img/icons/administrative.png
    children:
      - workflow: authentication
      - workflow: app_token_auth
  - title: Ingest and Upload Media
    icon: assets/img/icons/upload.png
    workflow: upload
  - title: Live Stream and Broadcast
    icon: assets/img/icons/play-back.png
    workflow: live_broadcast
  - title: Enrich and Organize Metadata
    icon: assets/img/icons/distribute.png
    children:
      - workflow: metadata
      - workflow: captions
      - workflow: webvtt_captions
  - title: Search, Discover and Personalize
    icon: assets/img/icons/publish.png
    children:
      - workflow: video_search
  - title: Engage and Publish
    icon: assets/img/icons/engage.png
    children:
      - workflow: dynamic_thumbnails
      - workflow: player_uiconf
      - workflow: player_external_skin_overrides
      - workflow: using_css_states
      - workflow: code_cue_points
      - workflow: quiz
      - workflow: ad_cue_points
  - title: Integration, Scheduling and Hooks
    icon: assets/img/icons/other.png
    children:
      - workflow: backend_notifications
  - title: Review Media Analytics
    icon: assets/img/icons/analytic.png
    children:
      - workflow: analytics
      - workflow: leaderboard_reports
  - title: Manage and Deliver Apps and Widgets
    icon: assets/img/icons/manage.png
    children:
      - workflow: app_token_auth
  - title: Add a Workflow
    icon: plus
    isAdd: true
  - title: Contact Us
    icon: assets/img/icons/contact.png
    isContact: true