@ourskyai/platform-api 1.3.8815 → 1.4.123

package/docs/V1GetOrCreateMountRequest.md

@@ -0,0 +1,24 @@
+# V1GetOrCreateMountRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model** | **string** |  | [optional] [default to undefined]
+**type** | [**MountType**](MountType.md) |  | [optional] [default to undefined]
+**geometry** | [**MountGeometry**](MountGeometry.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetOrCreateMountRequest } from '@ourskyai/platform-api';
+
+const instance: V1GetOrCreateMountRequest = {
+    model,
+    type,
+    geometry,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1GetPlateSolveCatalogDiffRequest.md

@@ -0,0 +1,20 @@
+# V1GetPlateSolveCatalogDiffRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**existingFiles** | [**Array<V1PlateSolveCatalogFile>**](V1PlateSolveCatalogFile.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetPlateSolveCatalogDiffRequest } from '@ourskyai/platform-api';
+
+const instance: V1GetPlateSolveCatalogDiffRequest = {
+    existingFiles,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1GetSuntimesResponse.md

@@ -0,0 +1,36 @@
+# V1GetSuntimesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodeId** | **string** |  | [optional] [default to undefined]
+**sunrise** | **string** |  | [default to undefined]
+**sunset** | **string** |  | [default to undefined]
+**civilRise** | **string** |  | [optional] [default to undefined]
+**civilSet** | **string** |  | [optional] [default to undefined]
+**nauticalRise** | **string** |  | [optional] [default to undefined]
+**nauticalSet** | **string** |  | [optional] [default to undefined]
+**astronomicalRise** | **string** |  | [optional] [default to undefined]
+**astronomicalSet** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetSuntimesResponse } from '@ourskyai/platform-api';
+
+const instance: V1GetSuntimesResponse = {
+    nodeId,
+    sunrise,
+    sunset,
+    civilRise,
+    civilSet,
+    nauticalRise,
+    nauticalSet,
+    astronomicalRise,
+    astronomicalSet,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1HFRStar.md

@@ -0,0 +1,25 @@
+# V1HFRStar
+
+HFR extracted star from the image
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**coordinates** | [**V1PixelCoordinates**](V1PixelCoordinates.md) |  | [optional] [default to undefined]
+**hfr** | **number** |  | [default to undefined]
+**flux** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1HFRStar } from '@ourskyai/platform-api';
+
+const instance: V1HFRStar = {
+    coordinates,
+    hfr,
+    flux,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1ImageFileType.md

@@ -0,0 +1,10 @@
+# V1ImageFileType
+
+
+## Enum
+
+* `FITS` (value: `'FITS'`)
+
+* `JPG` (value: `'JPG'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1ImageMetadata.md

@@ -0,0 +1,32 @@
+# V1ImageMetadata
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**imageId** | **string** |  | [default to undefined]
+**plateSolveResult** | [**V1PlateSolveResult**](V1PlateSolveResult.md) |  | [default to undefined]
+**inputStars** | [**Array<V1HFRStar>**](V1HFRStar.md) | Extracted star features from the image. Used as inputs to plate solving | [optional] [default to undefined]
+**sipCoefficients** | [**V1SIPCoefficients**](V1SIPCoefficients.md) |  | [optional] [default to undefined]
+**photometricZeroPoint** | **number** | Photometric zero point offset. Add to instrumental magnitude (-2.5*log10(flux)) to get calibrated magnitude in standard photometric system. | [optional] [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1ImageMetadata } from '@ourskyai/platform-api';
+
+const instance: V1ImageMetadata = {
+    id,
+    imageId,
+    plateSolveResult,
+    inputStars,
+    sipCoefficients,
+    photometricZeroPoint,
+    createdAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1ImageRejectionReason.md

@@ -0,0 +1,64 @@
+# V1ImageRejectionReason
+
+
+## Enum
+
+* `TARGET_NOT_FOUND` (value: `'TARGET_NOT_FOUND'`)
+
+* `RATE_TARGET_NOT_FOUND` (value: `'RATE_TARGET_NOT_FOUND'`)
+
+* `RATE_PLATE_SOLVE_FAILURE` (value: `'RATE_PLATE_SOLVE_FAILURE'`)
+
+* `STREAK_DETECTION_FAILURE` (value: `'STREAK_DETECTION_FAILURE'`)
+
+* `PLATE_SOLVE_FAILURE` (value: `'PLATE_SOLVE_FAILURE'`)
+
+* `PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE` (value: `'PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE'`)
+
+* `PLATE_SOLVE_NO_SOLUTION_FAILURE` (value: `'PLATE_SOLVE_NO_SOLUTION_FAILURE'`)
+
+* `CROP_IMAGE_FAILURE` (value: `'CROP_IMAGE_FAILURE'`)
+
+* `COSMETIC_CORRECTION_FAILURE` (value: `'COSMETIC_CORRECTION_FAILURE'`)
+
+* `GRADIENT_REMOVAL_FAILURE` (value: `'GRADIENT_REMOVAL_FAILURE'`)
+
+* `CATMAG_FAILURE` (value: `'CATMAG_FAILURE'`)
+
+* `IMAGE_QUALITY_TOO_LOW` (value: `'IMAGE_QUALITY_TOO_LOW'`)
+
+* `OBSERVATION_NOT_FOUND` (value: `'OBSERVATION_NOT_FOUND'`)
+
+* `NODE_NOT_FOUND` (value: `'NODE_NOT_FOUND'`)
+
+* `CAMERA_NOT_FOUND` (value: `'CAMERA_NOT_FOUND'`)
+
+* `OTA_NOT_FOUND` (value: `'OTA_NOT_FOUND'`)
+
+* `TLE_NOT_EXTRACTED` (value: `'TLE_NOT_EXTRACTED'`)
+
+* `FAILED_TO_LOAD` (value: `'FAILED_TO_LOAD'`)
+
+* `GPS_ERROR` (value: `'GPS_ERROR'`)
+
+* `MUTEX_TIMEOUT` (value: `'MUTEX_TIMEOUT'`)
+
+* `AWAIT_TIMEOUT` (value: `'AWAIT_TIMEOUT'`)
+
+* `CATALOG_COMPARE_ERROR` (value: `'CATALOG_COMPARE_ERROR'`)
+
+* `SAVE_FAILURE` (value: `'SAVE_FAILURE'`)
+
+* `RATE_CATALOG_COMPARE_ERROR` (value: `'RATE_CATALOG_COMPARE_ERROR'`)
+
+* `MISSING_IMG_WIDTH_HEADER` (value: `'MISSING_IMG_WIDTH_HEADER'`)
+
+* `CALIBRATION_FAILURE` (value: `'CALIBRATION_FAILURE'`)
+
+* `HOT_PIXEL_REMOVAL_FAILURE` (value: `'HOT_PIXEL_REMOVAL_FAILURE'`)
+
+* `PIPELINE_TIMEOUT` (value: `'PIPELINE_TIMEOUT'`)
+
+* `UNKNOWN_ERROR` (value: `'UNKNOWN_ERROR'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1ImageSet.md

@@ -0,0 +1,43 @@
+# V1ImageSet
+
+An image set represents a contiguous set of observations of the same target captured by the same node.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**targetId** | **string** |  | [optional] [default to undefined]
+**ra** | **number** |  | [optional] [default to undefined]
+**dec** | **number** |  | [optional] [default to undefined]
+**nodeId** | **string** |  | [default to undefined]
+**observationId** | **string** |  | [optional] [default to undefined]
+**trackingType** | [**TrackingType**](TrackingType.md) |  | [default to undefined]
+**filterType** | [**FilterType**](FilterType.md) |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**ourskyPluginVersion** | **string** |  | [optional] [default to undefined]
+**isResolved** | **boolean** | True if this image set is from a resolved imaging observation. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1ImageSet } from '@ourskyai/platform-api';
+
+const instance: V1ImageSet = {
+    id,
+    targetId,
+    ra,
+    dec,
+    nodeId,
+    observationId,
+    trackingType,
+    filterType,
+    createdAt,
+    updatedAt,
+    ourskyPluginVersion,
+    isResolved,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1ImageSetImage.md

@@ -0,0 +1,77 @@
+# V1ImageSetImage
+
+Image Set Image
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**thumbnailUrl** | **string** |  | [optional] [default to undefined]
+**imageUrl** | **string** |  | [default to undefined]
+**fullJpgUrl** | **string** |  | [optional] [default to undefined]
+**nodeId** | **string** |  | [default to undefined]
+**targetId** | **string** |  | [optional] [default to undefined]
+**ra** | **number** |  | [optional] [default to undefined]
+**dec** | **number** |  | [optional] [default to undefined]
+**imageSetId** | **string** |  | [default to undefined]
+**darkCalibrated** | **boolean** |  | [default to undefined]
+**flatCalibrated** | **boolean** |  | [default to undefined]
+**biasCalibrated** | **boolean** |  | [default to undefined]
+**fwhmAverage** | **number** |  | [optional] [default to undefined]
+**fwhmStdDev** | **number** |  | [optional] [default to undefined]
+**fwhmAngle** | **number** |  | [optional] [default to undefined]
+**raOffset** | **number** |  | [optional] [default to undefined]
+**decOffset** | **number** |  | [optional] [default to undefined]
+**totalOffset** | **number** |  | [optional] [default to undefined]
+**totalOffsetStdDev** | **number** |  | [optional] [default to undefined]
+**totalOffsetRMS** | **number** |  | [optional] [default to undefined]
+**capturedAt** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**binning** | **number** |  | [optional] [default to undefined]
+**exposureLength** | **number** |  | [default to undefined]
+**fitsHeaders** | [**Array<FitsHeader>**](FitsHeader.md) |  | [default to undefined]
+**predictedStreakLocation** | [**V1PredictedStreakLocation**](V1PredictedStreakLocation.md) |  | [optional] [default to undefined]
+**rejectedReason** | [**V1ImageRejectionReason**](V1ImageRejectionReason.md) |  | [optional] [default to undefined]
+**featureSharpnessScore** | **number** | Sharpness score from resolved image processing. Null for non-resolved images. | [optional] [default to undefined]
+**executionEnvironment** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1ImageSetImage } from '@ourskyai/platform-api';
+
+const instance: V1ImageSetImage = {
+    id,
+    thumbnailUrl,
+    imageUrl,
+    fullJpgUrl,
+    nodeId,
+    targetId,
+    ra,
+    dec,
+    imageSetId,
+    darkCalibrated,
+    flatCalibrated,
+    biasCalibrated,
+    fwhmAverage,
+    fwhmStdDev,
+    fwhmAngle,
+    raOffset,
+    decOffset,
+    totalOffset,
+    totalOffsetStdDev,
+    totalOffsetRMS,
+    capturedAt,
+    createdAt,
+    binning,
+    exposureLength,
+    fitsHeaders,
+    predictedStreakLocation,
+    rejectedReason,
+    featureSharpnessScore,
+    executionEnvironment,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1ImageSetImageDot.md

@@ -0,0 +1,45 @@
+# V1ImageSetImageDot
+
+Data related to the extraction of a dot from an image.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**centroidRa** | **number** |  | [default to undefined]
+**centroidDec** | **number** |  | [default to undefined]
+**calibratedCentroidRa** | **number** |  | [default to undefined]
+**calibratedCentroidDec** | **number** |  | [default to undefined]
+**centroidTime** | **string** |  | [default to undefined]
+**centroidTimeIsGps** | **boolean** |  | [default to undefined]
+**centroidX** | **number** |  | [default to undefined]
+**centroidY** | **number** |  | [default to undefined]
+**snr** | **number** |  | [default to undefined]
+**magnitude** | **number** |  | [default to undefined]
+**magnitudeError** | **number** |  | [default to undefined]
+**magnitudeIsAbsolute** | **boolean** |  | [default to undefined]
+**magntiudeIsAccurate** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1ImageSetImageDot } from '@ourskyai/platform-api';
+
+const instance: V1ImageSetImageDot = {
+    centroidRa,
+    centroidDec,
+    calibratedCentroidRa,
+    calibratedCentroidDec,
+    centroidTime,
+    centroidTimeIsGps,
+    centroidX,
+    centroidY,
+    snr,
+    magnitude,
+    magnitudeError,
+    magnitudeIsAbsolute,
+    magntiudeIsAccurate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1ImageSetImageStreak.md

@@ -0,0 +1,57 @@
+# V1ImageSetImageStreak
+
+Data related to the extraction of a streak from an image.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**centerRa** | **number** |  | [default to undefined]
+**centerDec** | **number** |  | [default to undefined]
+**calibratedCenterRa** | **number** |  | [default to undefined]
+**calibratedCenterDec** | **number** |  | [default to undefined]
+**centerTime** | **string** |  | [default to undefined]
+**centerTimeIsGps** | **boolean** |  | [default to undefined]
+**startX** | **number** |  | [default to undefined]
+**startY** | **number** |  | [default to undefined]
+**endX** | **number** |  | [default to undefined]
+**endY** | **number** |  | [default to undefined]
+**startRa** | **number** |  | [default to undefined]
+**startDec** | **number** |  | [default to undefined]
+**endRa** | **number** |  | [default to undefined]
+**endDec** | **number** |  | [default to undefined]
+**snr** | **number** |  | [default to undefined]
+**magnitude** | **number** |  | [default to undefined]
+**magnitudeError** | **number** |  | [default to undefined]
+**magnitudeIsAbsolute** | **boolean** |  | [default to undefined]
+**magntiudeIsAccurate** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1ImageSetImageStreak } from '@ourskyai/platform-api';
+
+const instance: V1ImageSetImageStreak = {
+    centerRa,
+    centerDec,
+    calibratedCenterRa,
+    calibratedCenterDec,
+    centerTime,
+    centerTimeIsGps,
+    startX,
+    startY,
+    endX,
+    endY,
+    startRa,
+    startDec,
+    endRa,
+    endDec,
+    snr,
+    magnitude,
+    magnitudeError,
+    magnitudeIsAbsolute,
+    magntiudeIsAccurate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1Instruction.md

@@ -0,0 +1,31 @@
+# V1Instruction
+
+Instruction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**observation** | [**V1ObservationInstruction**](V1ObservationInstruction.md) |  | [optional] [default to undefined]
+**diagnostic** | [**V1DiagnosticInstruction**](V1DiagnosticInstruction.md) |  | [optional] [default to undefined]
+**search** | [**Array<V1ObservationInstruction>**](V1ObservationInstruction.md) |  | [optional] [default to undefined]
+**resolved** | [**V1ResolvedInstruction**](V1ResolvedInstruction.md) |  | [optional] [default to undefined]
+**autofocus** | [**V1AutoFocusInstruction**](V1AutoFocusInstruction.md) |  | [optional] [default to undefined]
+**terrestrialDownlink** | [**V1TerrestrialDownlinkInstruction**](V1TerrestrialDownlinkInstruction.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1Instruction } from '@ourskyai/platform-api';
+
+const instance: V1Instruction = {
+    observation,
+    diagnostic,
+    search,
+    resolved,
+    autofocus,
+    terrestrialDownlink,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1JobStatus.md

@@ -0,0 +1,16 @@
+# V1JobStatus
+
+
+## Enum
+
+* `PENDING` (value: `'PENDING'`)
+
+* `RUNNING` (value: `'RUNNING'`)
+
+* `SUCCEEDED` (value: `'SUCCEEDED'`)
+
+* `CANCELLED` (value: `'CANCELLED'`)
+
+* `FAILED` (value: `'FAILED'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1LastInstructionResponse.md

@@ -0,0 +1,24 @@
+# V1LastInstructionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**receivedAt** | **string** |  | [optional] [default to undefined]
+**trackingType** | [**TrackingType**](TrackingType.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1LastInstructionResponse } from '@ourskyai/platform-api';
+
+const instance: V1LastInstructionResponse = {
+    id,
+    receivedAt,
+    trackingType,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1LatestHfrResponse.md

@@ -0,0 +1,24 @@
+# V1LatestHfrResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodeId** | **string** |  | [optional] [default to undefined]
+**hfrValues** | **string** |  | [optional] [default to undefined]
+**timestamp** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1LatestHfrResponse } from '@ourskyai/platform-api';
+
+const instance: V1LatestHfrResponse = {
+    nodeId,
+    hfrValues,
+    timestamp,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1LogRecorded.md

@@ -0,0 +1,20 @@
+# V1LogRecorded
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**log** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1LogRecorded } from '@ourskyai/platform-api';
+
+const instance: V1LogRecorded = {
+    log,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1MLModel.md

@@ -0,0 +1,30 @@
+# V1MLModel
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**modelType** | [**ModelType**](ModelType.md) |  | [default to undefined]
+**modelDownloadUrl** | **string** |  | [default to undefined]
+**modelChecksum** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1MLModel } from '@ourskyai/platform-api';
+
+const instance: V1MLModel = {
+    id,
+    name,
+    modelType,
+    modelDownloadUrl,
+    modelChecksum,
+    createdAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1MatchedStar.md

@@ -0,0 +1,39 @@
+# V1MatchedStar
+
+Extracted stars that matched during plate solving
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**xCentroid** | **number** | The x-centroid | [default to undefined]
+**yCentroid** | **number** | The y-centroid | [default to undefined]
+**sequenceNumber** | **number** | The UCAC4 or GaiaUD number if known | [default to undefined]
+**magnitude** | **number** | Extracted magnitude | [default to undefined]
+**raRad** | **number** | The star RA | [default to undefined]
+**decRad** | **number** | The star Dec | [default to undefined]
+**catalogOffsetRad** | **number** | The calculated offset from the catalog star, if known. 0 otherwise | [default to undefined]
+**catalogOffsetMagnitude** | **number** |  | [optional] [default to undefined]
+**flux** | **number** |  | [default to undefined]
+**hfr** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1MatchedStar } from '@ourskyai/platform-api';
+
+const instance: V1MatchedStar = {
+    xCentroid,
+    yCentroid,
+    sequenceNumber,
+    magnitude,
+    raRad,
+    decRad,
+    catalogOffsetRad,
+    catalogOffsetMagnitude,
+    flux,
+    hfr,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1Metric.md

@@ -0,0 +1,30 @@
+# V1Metric
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**value** | **number** |  | [default to undefined]
+**tags** | **Array<string>** | List of colon separated key value pairs, i.e. [\"tag1:value1\",\"tag2:value2\"] | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**type** | [**MetricType**](MetricType.md) |  | [default to undefined]
+**measuredAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1Metric } from '@ourskyai/platform-api';
+
+const instance: V1Metric = {
+    name,
+    value,
+    tags,
+    description,
+    type,
+    measuredAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)