kaltura / developer-platform Goto Github PK

Origin for developer.kaltura.com

License: GNU Affero General Public License v3.0

JavaScript 76.87% C# 1.27% Java 1.23% PHP 1.39% Python 0.47% Ruby 0.53% Shell 0.49% CSS 12.47% HTML 0.73% Batchfile 0.04% TypeScript 1.70% Swift 0.68% SCSS 0.69% Pug 1.06% EJS 0.37%

developer-platform's Introduction

Kaltura API Documentation

This repository contains everything necessary to build documentation for the Kaltura VPaaS API using LucyBot.

The generated website is contained in kaltura/developer-platform-generated.

Documentation for LucyBot is available at docs.lucybot.com

Running

Running in Production

There are two target APIs: ovp (the standard Kaltura VPaaS) and ott.

ovp

npm install
git clone http://github.com/kaltura/developer-platform-generated generated/ovp
TARGET_API=ovp node server.js

ott

npm install
git clone http://github.com/kaltura/ott-developer-platform-generated generated/ott
TARGET_API=ott node server.js

Running in Development

npm install
TARGET_API=ovp lucybot build --prerender --truncate_prerender --destination generated/ovp
TARGET_API=ovp node server.js

or replace ovp with ott to build the OTT site.

Environment Options

Several options can be set using environment variables:

DEVELOPMENT - for use in active development, disables SSL and cache
NO_SSL
USE_CACHE
ENABLE_CROSS_ORIGIN
KALTURA_RECIPES_PORT
DISCOURSE_HOST
DISCOURSE_CATEGORY_ID
DISABLE_SWIFTYPE
ENABLE_HOMEPAGE
BASE_PATH
OTT_API_VERSION - relevant for 'ott' only. (e.g. v5_1_0)

Required in production

TARGET_API - either 'ott' or 'ovp'
KALTURA_SSO_SECRET
KALTURA_SSO_PAYLOAD
GITHUB_CLIENT_ID
GITHUB_CLIENT_SECRET
DISCOURSE_API_KEY - valid for forum.kaltura.org

Building

Any changes that are pushed to the master branch of kaltura/developer-platform will automatically trigger a Travis build. Travis will use LucyBot to update the generated/ folder with new HTML, CSS, and JS assets. Once Travis is finished, simply pull the result and restart the server.

Trigger a Build

If Travis fails, or you want to pull in the latest changes to LucyBot, you can manually trigger a build on Travis by pushing an empty commit:

git commit --allow-empty -m "Trigger CI"
git push

Testing

If you make changes to the codegen logic, you'll need to run the following to regenerate the test output:

WRITE_GOLDEN=true npm test

To check that there are no changes to codegen output, you can run:

npm test

developer-platform's People

Contributors

Stargazers

Watchers

developer-platform's Issues

Use 12px for body monotype font

Overall we should use a smaller font size for default body monotype font. Let’s switch to 12px like the old testme console.

Update code generation for Kaltura's new NodeJS SDK

There were updates to the NodeJS SDK. Updates are required to the codegen.
@tan-tan-kanarek - please advise on the details of what needs to be updated.

@AnnaAleksandrowicz - please note in case we need to update any docs.

Add dynamicEnums for uiConf in captions and dynamic_thumbnails

Performance optimizations to page loading times

The system needs a much much much faster page loading times, it currently loads too slowly.

Please look into performance optimizations, including:

Ahead-of-time compilation
Pre-rendering
On-demand loading of the OpenAPI document

Add codegen support for PHP Namespaces client library

Add code generation support the PHP with namespaces client.
See https://github.com/kaltura/KalturaGeneratedAPIClientsPHP53/tree/master/tests for code examples.

@jessp01 - please share any important implementation notes and other useful references.

Add codegen for the new Angular Client Library

Generated Client: https://github.com/kaltura/KalturaGeneratedAPIClientsAngular/
Client Generator: https://github.com/kaltura/clients-generator/tree/master/lib/ngx

See tests here -
https://github.com/kaltura/KalturaGeneratedAPIClientsAngular/blob/master/src/api/tests

@bobby-brennan - please let me know estimated time for this task, and whether you have questions.

Youtube videos added in mediaspace not reflecting in KMC console.

Hello:
I am working on a web app where KMC videos software is used. I am all new to this technology.
I am able to get the list of videos from KMC to website.
However, I tried adding the videos from youtube using mediaspace admin access.
I have added new channel and the new channel is reflected in KMC console. but, I am not able to view the list of videos added in mediaspace admin in KMC console.

I am not sure where I am doing wrong.
A suggestion would be a great help.

Expand side-menu in docs while searching

When searching, the side-menu doc groups should be expanded (open) when typing, and not closed… that way you could see the actual result (e.g media.list) and not just the group labels.

Create a new homepage design that will focus quick start for newcomers

Update the homepage (the page seen when visiting the base url; developer.kaltura.com) to be friendlier to new comers.
See early sketch here - Developer Homepage[1].pdf

Resource parameter in addContent action is not working

media.addContent resource parameter is faulty, it should show all the resource types, but currently is not showing any. See comparison of how it’s in the old test console:

compared to:

Add a new section for Web Player and Mobile Player SDKs (just like API-docs)

This section will feature the downloads, github links, demonstrations, and documentation pages.

@AnnaAleksandrowicz, @OrenMe and @itaykinnrot - assigning to you to help define how and what we'd like to have before we assign to @bobby-brennan for development.

Console issues with data entry and fileAsset

Please see attached screenshots.

data.update action is using documentEntry instead of dataEntry.

data.get entryId field is showing a dropdown of MEDIA entries instead of data entries... in non-Media entries it's best to keep this field an open text.

fileAsset.get id field is showing a dropdown instead of int filed, and it's also broken.

OTT - action thrown errors don't show their description

In action documentation page, under errors tab, we show today the message of each error.
In OTT, many errors don't have a message, in such case we should show the description instead.

Remove Categories from the Console menu

If the user goes to the console, they already know what they're looking for, so the categories aren't needed and are actually somewhat confusing/time consuming.
Here we should just present a flat view of services.

@tzubeli / @jessp01 - FYI

Ensure objects are linkable to their definitions so that it’s easy to navigate

workflows/Generate_API_Sessions/App_Token_Authentication - "Show setup" is missing

Configure versions support for the ott site

Configure the site to load multiple schemas. (feature is already available, this only needs to be configured).

@tan-tan-kanarek - let us know if you need any further assistance or changes for this.

On lucyBot build get the workflows directory from config

create a subfolders in 'workflows' folder one for ovp and one for ott- which will contain all the workflows for ovp and other for the ott.
Allow to configure the path of workflows folder and use it in addWorkflows function in lucyBot build script instead of using hardcoded folder name which is 'workflows'

Node Sass does not yet support your current environment: Linux 64-bit with Unsupported runtime (64)

lucybot build --prerender --destination generated/ott --basePath /doc/
Building documentation in /home/dev/jenkins/workspace/Generate-Docs/developer-platform/generated/ott

[email protected] build:client /usr/lib/node_modules/lucybot
ng build --aot --extract-css

[BABEL] Note: The code generator has deoptimised the styling of "/usr/lib/node_modules/lucybot/node_modules/@angular/core/esm5/core.js" as it exceeds the max of "500KB".
Date: 2018-10-08T12:21:47.756Z
Hash: beb6ce43daa39e23542f
Time: 39751ms
chunk {inline} inline.bundle.js, inline.bundle.js.map (inline) 3.89 kB [entry] [rendered]
chunk {main} main.bundle.js, main.bundle.js.map (main) 760 kB [initial] [rendered]
chunk {polyfills} polyfills.bundle.js, polyfills.bundle.js.map (polyfills) 1.62 MB [initial] [rendered]
chunk {scripts} scripts.bundle.js, scripts.bundle.js.map (scripts) 502 kB [initial] [rendered]
chunk {styles} styles.bundle.css, styles.bundle.css.map (styles) 159 kB [initial] [rendered]
chunk {vendor} vendor.bundle.js, vendor.bundle.js.map (vendor) 3.22 MB [initial] [rendered]

ERROR in ./src/app/styles/bootstrap.scss
Module build failed: Error: Node Sass does not yet support your current environment: Linux 64-bit with Unsupported runtime (64)
For more information on which environments are supported please see:
https://github.com/sass/node-sass/releases/tag/v3.13.1
at module.exports (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/binding.js:13:13)
at Object. (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/index.js:14:35)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at require (internal/modules/cjs/helpers.js:20:18)
at Object. (/usr/lib/node_modules/lucybot/node_modules/sass-loader/index.js:4:12)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
ERROR in ./src/app/styles/styles.scss
Module build failed: Error: Node Sass does not yet support your current environment: Linux 64-bit with Unsupported runtime (64)
For more information on which environments are supported please see:
https://github.com/sass/node-sass/releases/tag/v3.13.1
at module.exports (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/binding.js:13:13)
at Object. (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/index.js:14:35)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at require (internal/modules/cjs/helpers.js:20:18)
at Object. (/usr/lib/node_modules/lucybot/node_modules/sass-loader/index.js:4:12)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
ERROR in ./src/app/styles/components.scss
Module build failed: Error: Node Sass does not yet support your current environment: Linux 64-bit with Unsupported runtime (64)
For more information on which environments are supported please see:
https://github.com/sass/node-sass/releases/tag/v3.13.1
at module.exports (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/binding.js:13:13)
at Object. (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/index.js:14:35)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at require (internal/modules/cjs/helpers.js:20:18)
at Object. (/usr/lib/node_modules/lucybot/node_modules/sass-loader/index.js:4:12)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
ERROR in ./src/app/styles/bootstrap.scss
Module build failed: ModuleBuildError: Module build failed: Error: Node Sass does not yet support your current environment: Linux 64-bit with Unsupported runtime (64)
For more information on which environments are supported please see:
https://github.com/sass/node-sass/releases/tag/v3.13.1
at module.exports (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/binding.js:13:13)
at Object. (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/index.js:14:35)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at require (internal/modules/cjs/helpers.js:20:18)
at Object. (/usr/lib/node_modules/lucybot/node_modules/sass-loader/index.js:4:12)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at runLoaders (/usr/lib/node_modules/lucybot/node_modules/webpack/lib/NormalModule.js:195:19)
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:364:11
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:170:18
at loadLoader (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/loadLoader.js:27:11)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:169:2)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:165:10)
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:173:18
at loadLoader (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/loadLoader.js:36:3)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:169:2)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:165:10)
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:173:18
at loadLoader (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/loadLoader.js:36:3)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:169:2)
at runLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:362:2)
at NormalModule.doBuild (/usr/lib/node_modules/lucybot/node_modules/webpack/lib/NormalModule.js:182:3)
at NormalModule.build (/usr/lib/node_modules/lucybot/node_modules/webpack/lib/NormalModule.js:275:15)
ERROR in ./src/app/styles/styles.scss
Module build failed: ModuleBuildError: Module build failed: Error: Node Sass does not yet support your current environment: Linux 64-bit with Unsupported runtime (64)
For more information on which environments are supported please see:
https://github.com/sass/node-sass/releases/tag/v3.13.1
at module.exports (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/binding.js:13:13)
at Object. (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/index.js:14:35)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at require (internal/modules/cjs/helpers.js:20:18)
at Object. (/usr/lib/node_modules/lucybot/node_modules/sass-loader/index.js:4:12)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at runLoaders (/usr/lib/node_modules/lucybot/node_modules/webpack/lib/NormalModule.js:195:19)
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:364:11
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:170:18
at loadLoader (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/loadLoader.js:27:11)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:169:2)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:165:10)
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:173:18
at loadLoader (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/loadLoader.js:36:3)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:169:2)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:165:10)
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:173:18
at loadLoader (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/loadLoader.js:36:3)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:169:2)
at runLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:362:2)
at NormalModule.doBuild (/usr/lib/node_modules/lucybot/node_modules/webpack/lib/NormalModule.js:182:3)
at NormalModule.build (/usr/lib/node_modules/lucybot/node_modules/webpack/lib/NormalModule.js:275:15)
ERROR in ./src/app/styles/components.scss
Module build failed: ModuleBuildError: Module build failed: Error: Node Sass does not yet support your current environment: Linux 64-bit with Unsupported runtime (64)
For more information on which environments are supported please see:
https://github.com/sass/node-sass/releases/tag/v3.13.1
at module.exports (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/binding.js:13:13)
at Object. (/usr/lib/node_modules/lucybot/node_modules/node-sass/lib/index.js:14:35)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at require (internal/modules/cjs/helpers.js:20:18)
at Object. (/usr/lib/node_modules/lucybot/node_modules/sass-loader/index.js:4:12)
at Module._compile (internal/modules/cjs/loader.js:689:30)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
at Module.load (internal/modules/cjs/loader.js:599:32)
at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
at Function.Module._load (internal/modules/cjs/loader.js:530:3)
at Module.require (internal/modules/cjs/loader.js:637:17)
at runLoaders (/usr/lib/node_modules/lucybot/node_modules/webpack/lib/NormalModule.js:195:19)
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:364:11
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:170:18
at loadLoader (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/loadLoader.js:27:11)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:169:2)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:165:10)
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:173:18
at loadLoader (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/loadLoader.js:36:3)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:169:2)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:165:10)
at /usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:173:18
at loadLoader (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/loadLoader.js:36:3)
at iteratePitchingLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:169:2)
at runLoaders (/usr/lib/node_modules/lucybot/node_modules/loader-runner/lib/LoaderRunner.js:362:2)
at NormalModule.doBuild (/usr/lib/node_modules/lucybot/node_modules/webpack/lib/NormalModule.js:182:3)
at NormalModule.build (/usr/lib/node_modules/lucybot/node_modules/webpack/lib/NormalModule.js:275:15)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] build:client: ng build --aot --extract-css
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] build:client script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

Fix search behavior

Update the Search behavior to:

Search should also search inside the docs and not just based on titles/metadata.
Do not show duplicate items in the

Consider using SwiftType (account details provided privately) as search API when online... BUT, need to carefully consider how we deal with offline (if user using docs and is not connected) and multiple schema versions.

workflows/Ingest_and_Upload_Media;step=2 - wrong params passed to uploadToken->upload()

Consider the code https://developer.kaltura.com:8443/workflows/Ingest_and_Upload_Media;step=2 produces:

$result = $client->uploadToken->upload($ks, $format, $uploadTokenId, $fileData, $resume, $finalChunk, $resumeAt);

results = client.upload_token_service.upload(ks, format, upload_token_id, file_data, resume, final_chunk, resume_at)

The signature for this function is:

function uploadAction($uploadTokenId, $fileData, $resume = false, $finalChunk = true, $resumeAt = -1)

So ks and format should not be there.

The above PHP and Ruby samples are just for illustration, same is true to all code generators.

Enums selectboxes should be displayed with the actual value in brackets

Where there is a selectbox with enums, their names should be displayed with the actual value in brackets. for example:

EXACT_MATCH (1)
PARTIAL (2)
STARTS_WITH (3)
EXISTS (4)
RANGE (5)

As opposed to now where only the literal value populates the selectbox.

action docs/console should present the correct properties based on the selected objectType

Objects presented in the docs or console, should only show the properties of the objectType selected (e.g. in baseEntry.add) - never show the inheriting objects properties, only the properties of the objectType that was selected.

Make cURL the default language, and save language preference in cookie

Once cURL codegen (#1) is added, make it the default language (if the user didn't select a language yet). If the user changed the language, store it in a cookie and load it as default instead.

NodeJS codegen only - checking "Show setup" in the "Authentication" workflow behaves incorrectly

See https://developer.kaltura.com:8443/workflows/Generate_API_Sessions/Authentication;step=1, which points to an instance deployed with the latest from the master branch.

Select "NodeJS" and check "Show setup". Generated code is:

const kaltura = require('kaltura-client');
const config = new kaltura.Configuration();
config.serviceUrl = 'https://www.kaltura.com';
const client = new kaltura.Client(config);

Uncheck "Show setup". Generated code is:

let secret = "********************************";
let userId = "[email protected]";
let type = kaltura.enums.SessionType.ADMIN;
let partnerId = "2141171";
let expiry = 86400;
let privileges = "";

kaltura.services.session.start(secret, userId, type, partnerId, expiry, privileges)
.execute(client)
.then(result => {
    console.log(result);
});

Create a codegen for the TypeScript Client Library

As per the discussion at #50 - the TypeScript client is also ready to be released. Let's create a codegen for.

@bobby-brennan - units for this client can be found here:
https://github.com/kaltura/KalturaGeneratedAPIClientsTypescript/tree/master/src/tests

issue with edit / create workflows

Following this issue: #78 which was implemented in lucyBot v4.4.
While trying to save or load a workflow getting http 404 error since load workflow path is wrong – currently the path lucyBot using is workflows/${workflowName} but since the path to workflows is configurable it should be taken from workflowDirectory setting (/${workflowDirectory }/${workflowName}).

This issue prevents us from edit / create workflows in order to solve changes in lucyBot required.

Update URL structure for better SEO

Direct Action URL – Urls shows be replaced to be of the structure: domain/apidocs/service/x/action/y . It is fairly descriptive and also short enough to render fully in the Google search result.

https://www.youtube.com/watch?v=AQcSFsQyct8 explains underscores vs. hyphens.

In our case since underscores literally are the name of the API, it actually does make sense to continue using underscores.

However, we should stop using hash (#) because these are used to indicate fragments on the page (and in fact something we do want to support, deep link inside the page and having Google index these fragments).

Add code generation support for Kaltura's Swift SDK

@tan-tan-kanarek - please add information regarding this new client, docs, examples, important notes for how to create the code gen for it.

Please add word-break: break-word; to code blocks

See this as reference:
https://developer.kaltura.com/api-docs/Deliver-and-Distribute-Media/playManifest-streaming-api.html

You'll note that the single code lines (like the first code showing URL structure) are not breaking, and thus making the whole page too wide.

To resolve, please add word-break: break-word; to code blocks.

workflows/Ingest_and_Upload_Media;step=2 fails when using Firefox

After submitting the form in step 2, the uploadToken.upload() request fails with:

{
  "code": "UPLOAD_TOKEN_INVALID_STATUS_FOR_UPLOAD",
  "message": "Upload token is in an invalid status for uploading a file, maybe the file was already uploaded",
  "objectType": "KalturaAPIException",
  "args": []
}

Can be reproduced here: https://developer.kaltura.com:8443/workflows/Ingest_and_Upload_Media;step=2

This works correctly when using Chrome. @bobby-brennan - sent you a HAR file by mail.

I'm using Firefox 60.0 but I believe it will reproduce with other versions as well.

Show inheritance between objects (replacing json-editor)

Replace json-editor with a fully-functional editor for Kaltura Objects, that will show links between inheritance in the render.

Support exact match in search - media.list should show the action first in the side menu

If there’s an exact match, simply present it on its own outside categories (e.g. “media.” Will show as usual but with open tree, and “media.list” will actually show the media.list action.)

Show boolean parameters as a true/false dropdown or toggle

Currently boolean params are text input... please change to true/false dropdown or toggle button.

Fix side-menu search - missing results

The search results currently vary between the side-menu and the results. This means that in the console view, some results are missing. For example, consider the term "esearch", when in the "API Docs" tab, I get the expected result in the search results but the side menu is empty, when in "Console", I get no results.

objectType property should always be at the top before all other properties

In docs and console, whenever an objectType exists, it should be shown as the first parameter, to reflect the importance of specifying its value before other parameters that are influenced by the selected objectType.

objectType is missing from nested schemas

See screenshot:

Related actions/services

Support metadata specification for each doc so that you could add tags in the form of SERVICE.ACTION [for instance category.add, categoryEntry.update], then, when generating the site, iterate over the metadata and index it so that if a person views the API documentation for services and actions for which a corresponding tag exists, a "see also" reference will appear.

Presentation wise, it will also show this in search results (under the search results show “Related Topics:” in smaller font, and have all tags be clickable).

@jessp01 - please advise on how you think we should store this information in the schema.

Please add margin-bottom: 15px; to tables in docs

See this page as reference:
https://developer.kaltura.com/api-docs/Deliver-and-Distribute-Media/playManifest-streaming-api.html

The text below tables is too close to the tables, making it easy to miss.

To resolve, please add a margin to the bottom of tables: margin-bottom: 15px;.

Switching between accounts of the same logged in user

Add ability to switch accounts (currently it requires logoff and login again). Important capability for customers who manage multiple accounts (e.g. staging and production, or parent and sub accounts).

Update code generation for Kaltura's new Java SDK

There were updates to the Java SDK. Updates are required to the codegen.
@tan-tan-kanarek - please advise on the details of what needs to be updated.

@AnnaAleksandrowicz - please note in case we need to update any docs.

workflows/Ingest_and_Upload_Media - not all langs are available

See https://developer.kaltura.com:8443/workflows/Ingest_and_Upload_Media;step=1 [and also step=2] which points to an instance deployed with the latest from the master branch.

Only available langs in the select box are:

PHP
NodeJS
Ruby
JS

In step 3, this is no longer the case.

Relative path for multiple schemas

Support relative path in order to place entire system under sub directory, e.g. https://ott.developer.kaltura.com/v4.7/ or http://customername.com/staging/

@bobby-brennan - you mentioned this is easily doable. Can you please share details on how?

Add cURL code generation capability

Add code generation for cURL reference. Note that with cURL the global format parameter should show in the sample code (unlike other languages, here it is usable and can be set).

Ability to annotate services and actions as beta was added to the client generator

See https://github.com/kaltura/clients-generator/pull/293/files

Following that, the "beta" attribute should be inspected when parsing the API schema.
If set to true, the behaviour should be exactly the same as with the deprecated attribute only the message should be:
"Please note: this <SERVICE_NAME/ACTION_NAME> is experimental."