Skip to content

Latest commit

 

History

History
90 lines (64 loc) · 3.17 KB

README.md

File metadata and controls

90 lines (64 loc) · 3.17 KB

Open CU Services SDK for TypeScript

The master branch does not store source code of SDKs, instead code is stored in the SDK branches and version tags:

  • latest SDK branch: typescript/{SDK_ID}, for example typescript/lmsapi
  • versioned SDK tag: typescript/{SDK_ID}/v{VERSION}, for example typescript/lmsapi/v0.1.0

Available SDKs

CU LMS API (lmsapi)

Latest Release Spec Debug Response Support

npm Node.js License

Installation

Install the package from npm:

npm install @cu-devs-collective/open-cu-services-lmsapi

Install from a Git repository tag

If you need to install a specific repository tag, use a package manager that supports git dependencies with a subdirectory path. Recommended package manager for this flow is pnpm.

Add the dependency to your package.json:

{
  "dependencies": {
    "@cu-devs-collective/open-cu-services-lmsapi": "git+https://github.com/cu-devs-collective/open-cu-services-sdk#typescript/lmsapi/v0.1.0&path:/typescript/lmsapi"
  }
}

Then install dependencies:

pnpm install

Examples

See examples/typescript for runnable examples.

Development

When working against a local checkout of a generated SDK branch or tag, use a file dependency. This works for npm and pnpm:

{
  "dependencies": {
    "@cu-devs-collective/open-cu-services-lmsapi": "file:../../typescript/lmsapi"
  }
}

Then install dependencies with your package manager:

# npm
npm install
# pnpm
pnpm install

This override only works when the checked-out ref contains the generated package at typescript/lmsapi.

Reporting Issues

Please read Reporting Issues for Codegen Clients and use the Codegen client issue report template for codegen client issues.