Truepic Vision API Types

TypeScript type declarations for Truepic Vision API v3.

Installation

npm install @truepic/vision-api-types

Usage

import type { components, paths } from '@truepic/vision-api-types'

type VisionInspectionSchema = components['schemas']['Inspection']
type VisionGetInspectionsPath = paths['/inspections']['get']

OpenAPI TypeScript is used to generate the types from the Vision API OpenAPI specification.

Publishing

This package is published automatically by the vision-api production deployment workflow. Its version is kept in lockstep with vision-api.

To regenerate index.d.ts locally:

# from the repo root
npm run build                # builds dist/Vision-API-V3.json
cd types
npm install
npm run generate
npm run validate