xwiki-xwiki-platform

Namespace

xwiki-xwiki-platform

Description:

  • Empower your team's collaboration with XWiki Platform, a versatile and robust wiki solution perfect for building seamless, interactive applications. Share knowledge and streamline workflows effortlessly.

Author:
Copyright:
  • 2025 Eyevinn Technology AB

Methods

(async, static) createXwikiXwikiPlatformInstance(context, body) → {XwikiXwikiPlatform}

Description:

  • Create a new XWiki instance

Example
import { Context } from '@osaas/client-core';
import { createXwikiXwikiPlatformInstance } from '@osaas/client-services';

const ctx = new Context();
const body: XwikiXwikiPlatformConfig = { name: 'myinstance', ... };
const instance = await createXwikiXwikiPlatformInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body XwikiXwikiPlatformConfig

Service instance configuration
Returns:
  • Service instance
Type
XwikiXwikiPlatform

(async, static) getXwikiXwikiPlatformInstance(context, name) → {XwikiXwikiPlatform}

Description:

  • Get a XWiki instance

Example
import { Context } from '@osaas/client-core';
import { getXwikiXwikiPlatformInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getXwikiXwikiPlatformInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the xwiki-platform to be retrieved
Returns:
  • Service instance
Type
XwikiXwikiPlatform

(async, static) removeXwikiXwikiPlatformInstance(context, name)

Description:

  • Remove a XWiki instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the xwiki-platform to be removed