Data API TypeScript Client

Auto-generated TypeScript client for the Data API, created from OpenAPI specification using OpenAPI Generator.

Installation

From GitLab Package Registry

# Configure GitLab registry (one-time setup)
npm config set @alias3:registry https://gitlab.com/api/v4/projects/${PROJECT_ID}/packages/npm/

# Install the package
npm install @alias3/data-api-client

For CI/CD (using CI_JOB_TOKEN)

In your .gitlab-ci.yml:

before_script:
  - echo "@alias3:registry=${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/" > .npmrc
  - echo "${CI_API_V4_URL#https?}/projects/${CI_PROJECT_ID}/packages/npm/:_authToken=${CI_JOB_TOKEN}" >> .npmrc
  - npm install

Usage

import { Configuration, DatasetsApi, EntriesApi } from '@alias3/data-api-client';

// Configure the client
const config = new Configuration({
  basePath: 'https://client-cluster.example.com',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});

// Create API instances
const datasetsApi = new DatasetsApi(config);
const entriesApi = new EntriesApi(config);

// Use the API
async function getDataset(id: number) {
  const dataset = await datasetsApi.getDataset({ id });
  console.log(dataset);
}

// Batch get entries
async function getEntries(datasetId: number, limit: number = 50) {
  const response = await entriesApi.batchGetEntries({
    datasetId,
    limit
  });
  console.log(response.entries);
}

API Documentation

Full API documentation is available at your Data API instance:

• Swagger UI: https://your-data-api.com/docs
• OpenAPI Spec: https://your-data-api.com/openapi.json

Generated Code

This client is automatically generated from the OpenAPI specification. Do not manually edit the generated files in src/ - they will be overwritten on the next generation.

Version

Current version: 1.0.0

Generated with: OpenAPI Generator 7.17.0