@ourskyai/platform-api 1.3.8815 → 1.4.118
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +160 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +265 -4
- package/api.ts +1568 -5774
- package/base.ts +14 -24
- package/common.ts +20 -44
- package/configuration.ts +37 -17
- package/dist/api.d.ts +978 -5071
- package/dist/api.js +968 -1150
- package/dist/base.d.ts +11 -23
- package/dist/base.js +5 -18
- package/dist/common.d.ts +6 -37
- package/dist/common.js +18 -40
- package/dist/configuration.d.ts +30 -15
- package/dist/configuration.js +5 -3
- package/dist/esm/api.d.ts +978 -5071
- package/dist/esm/api.js +968 -1150
- package/dist/esm/base.d.ts +11 -23
- package/dist/esm/base.js +4 -17
- package/dist/esm/common.d.ts +6 -37
- package/dist/esm/common.js +16 -39
- package/dist/esm/configuration.d.ts +30 -15
- package/dist/esm/configuration.js +5 -3
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CameraMode.md +10 -0
- package/docs/DefaultApi.md +3904 -0
- package/docs/EmptySuccess.md +20 -0
- package/docs/FilterType.md +60 -0
- package/docs/FitsHeader.md +22 -0
- package/docs/ImageSetType.md +24 -0
- package/docs/Location.md +25 -0
- package/docs/MetricType.md +14 -0
- package/docs/ModelType.md +10 -0
- package/docs/MountGeometry.md +10 -0
- package/docs/MountType.md +10 -0
- package/docs/NetworkInterface.md +15 -0
- package/docs/NodeState.md +20 -0
- package/docs/OrbitType.md +42 -0
- package/docs/PKICertificate.md +30 -0
- package/docs/PlateSolveParameters.md +26 -0
- package/docs/ShutterType.md +10 -0
- package/docs/StreakExtractionSource.md +35 -0
- package/docs/SuccessfulCreate.md +20 -0
- package/docs/TrackingType.md +12 -0
- package/docs/UploadPriority.md +10 -0
- package/docs/V1AccessToken.md +43 -0
- package/docs/V1AccessTokenType.md +12 -0
- package/docs/V1AllSkyCameraConfig.md +22 -0
- package/docs/V1AllSkyImageForImage.md +28 -0
- package/docs/V1AllSkyPrediction.md +30 -0
- package/docs/V1AllSkyPredictionLabel.md +16 -0
- package/docs/V1ApexChartsTimeline.md +20 -0
- package/docs/V1ApexChartsTimelineElement.md +24 -0
- package/docs/V1AssetSize.md +10 -0
- package/docs/V1AutoFocusInstruction.md +23 -0
- package/docs/V1AutoFocusInstructionCoordinatesInner.md +23 -0
- package/docs/V1BlackoutBox.md +26 -0
- package/docs/V1Camera.md +47 -0
- package/docs/V1CameraRollImage.md +34 -0
- package/docs/V1ClientToken.md +22 -0
- package/docs/V1CompleteNodeControllerCrashReportRequest.md +20 -0
- package/docs/V1CompleteNodeFlareRequest.md +20 -0
- package/docs/V1CompleteObservationRequest.md +20 -0
- package/docs/V1CreateAllSkyPredictionRequest.md +24 -0
- package/docs/V1CreateAutofocusResultRequest.md +28 -0
- package/docs/V1CreateImageMetadataRequest.md +26 -0
- package/docs/V1CreateImageSetImageRequest.md +32 -0
- package/docs/V1CreateImageSetImageResponse.md +23 -0
- package/docs/V1CreateImageSetImageUploadUrlRequest.md +26 -0
- package/docs/V1CreateImageSetImageUploadUrlResponse.md +20 -0
- package/docs/V1CreateImageSetRequest.md +28 -0
- package/docs/V1CreateNodeControllerArtifactRequest.md +20 -0
- package/docs/V1CreateNodeControllerCrashReportRequest.md +37 -0
- package/docs/V1CreateNodeControllerCrashReportResponse.md +22 -0
- package/docs/V1CreateNodeDiagnostic.md +28 -0
- package/docs/V1CreateNodeDiagnosticsRequest.md +22 -0
- package/docs/V1CreateNodeEvent.md +24 -0
- package/docs/V1CreateNodeEventsRequest.md +22 -0
- package/docs/V1CreateNodeFlareRequest.md +22 -0
- package/docs/V1CreateNodeFlareResponse.md +22 -0
- package/docs/V1CreateNodeRequest.md +37 -0
- package/docs/V1CreateProcessedImageSetImageRequest.md +67 -0
- package/docs/V1CreateTimeWindowedAssetRequest.md +34 -0
- package/docs/V1CreateTimeWindowedAssetResponse.md +22 -0
- package/docs/V1DataSource.md +10 -0
- package/docs/V1DiagnosticInstruction.md +21 -0
- package/docs/V1DisableDebugServices.md +22 -0
- package/docs/V1DurationMeasured.md +24 -0
- package/docs/V1ElevationMaskPoint.md +25 -0
- package/docs/V1EnableAutonomousOperation.md +22 -0
- package/docs/V1EnableDebugServices.md +26 -0
- package/docs/V1EnableManualOperation.md +22 -0
- package/docs/V1FileType.md +8 -0
- package/docs/V1Focuser.md +27 -0
- package/docs/V1GainCurve.md +25 -0
- package/docs/V1GainCurvePoint.md +22 -0
- package/docs/V1GenerateEdgeTokenResponse.md +22 -0
- package/docs/V1GetInstructionRequest.md +28 -0
- package/docs/V1GetInstructionRequestUploadHealth.md +24 -0
- package/docs/V1GetNodeCommandsResponse.md +20 -0
- package/docs/V1GetNodes.md +20 -0
- package/docs/V1GetOrCreateCameraRequest.md +60 -0
- package/docs/V1GetOrCreateFocuserRequest.md +24 -0
- package/docs/V1GetOrCreateMountRequest.md +24 -0
- package/docs/V1GetPlateSolveCatalogDiffRequest.md +20 -0
- package/docs/V1GetSuntimesResponse.md +36 -0
- package/docs/V1HFRStar.md +25 -0
- package/docs/V1ImageFileType.md +10 -0
- package/docs/V1ImageMetadata.md +32 -0
- package/docs/V1ImageRejectionReason.md +64 -0
- package/docs/V1ImageSet.md +43 -0
- package/docs/V1ImageSetImage.md +77 -0
- package/docs/V1ImageSetImageDot.md +45 -0
- package/docs/V1ImageSetImageStreak.md +57 -0
- package/docs/V1Instruction.md +31 -0
- package/docs/V1JobStatus.md +16 -0
- package/docs/V1LastInstructionResponse.md +24 -0
- package/docs/V1LatestHfrResponse.md +24 -0
- package/docs/V1LogRecorded.md +20 -0
- package/docs/V1MLModel.md +30 -0
- package/docs/V1MatchedStar.md +39 -0
- package/docs/V1Metric.md +30 -0
- package/docs/V1Mount.md +23 -0
- package/docs/V1Node.md +59 -0
- package/docs/V1NodeCommand.md +34 -0
- package/docs/V1NodeComponentType.md +34 -0
- package/docs/V1NodeConfigBody.md +20 -0
- package/docs/V1NodeConfigKeyMetadata.md +26 -0
- package/docs/V1NodeConfigScopeType.md +12 -0
- package/docs/V1NodeController.md +36 -0
- package/docs/V1NodeControllerArtifact.md +20 -0
- package/docs/V1NodeControllerBootstrapRequest.md +20 -0
- package/docs/V1NodeControllerIssueCertificateResponse.md +32 -0
- package/docs/V1NodeControllerIssueCertificateResponseRsaKeyPair.md +24 -0
- package/docs/V1NodeControllerMacAddressesInner.md +22 -0
- package/docs/V1NodeControllerStatus.md +13 -0
- package/docs/V1NodeDiagnosticType.md +80 -0
- package/docs/V1NodeEventType.md +32 -0
- package/docs/V1NodeFlare.md +25 -0
- package/docs/V1NodeWithLocation.md +23 -0
- package/docs/V1OAuthAuthorizeRequest.md +26 -0
- package/docs/V1OAuthAuthorizeResponse.md +20 -0
- package/docs/V1OAuthTokenRequest.md +24 -0
- package/docs/V1OAuthTokenResponse.md +22 -0
- package/docs/V1OTAEncryptionRequestLatest.md +20 -0
- package/docs/V1OTAEncryptionResult.md +30 -0
- package/docs/V1ObservationInstruction.md +79 -0
- package/docs/V1ObservationInstructionAscomAxisRates.md +35 -0
- package/docs/V1ObservationInstructionSatellitePassEphemerisInner.md +25 -0
- package/docs/V1ObservationMetrics.md +30 -0
- package/docs/V1OpticalTube.md +27 -0
- package/docs/V1PixelCoordinates.md +23 -0
- package/docs/V1PlateSolveCatalogFile.md +22 -0
- package/docs/V1PlateSolveCatalogFileDownload.md +26 -0
- package/docs/V1PlateSolveResult.md +40 -0
- package/docs/V1PlateSolveStatus.md +12 -0
- package/docs/V1PredictedStreakLocation.md +26 -0
- package/docs/V1PrincipalRoleType.md +20 -0
- package/docs/V1ProductRevision.md +12 -0
- package/docs/V1ReadNoisePoint.md +22 -0
- package/docs/V1RebootSystem.md +22 -0
- package/docs/V1RefreshCertificateRequest.md +20 -0
- package/docs/V1RegisterNodeControllerRequest.md +24 -0
- package/docs/V1RequestMacAddressesRequest.md +22 -0
- package/docs/V1RequestMacAddressesResponse.md +20 -0
- package/docs/V1RequestMacAddressesResponseMacAddressesInner.md +22 -0
- package/docs/V1ResolvedInstruction.md +85 -0
- package/docs/V1SIPCoefficients.md +40 -0
- package/docs/V1SafetyStatusUpdated.md +20 -0
- package/docs/V1SendFlare.md +40 -0
- package/docs/V1SetupAction.md +23 -0
- package/docs/V1SoftwarePackageType.md +8 -0
- package/docs/V1SoftwareRelease.md +34 -0
- package/docs/V1SoftwareRuntimeEnvironmentType.md +9 -0
- package/docs/V1SystemVariant.md +34 -0
- package/docs/V1TerrestrialDownlinkInstruction.md +33 -0
- package/docs/V1TimeWindowedAsset.md +37 -0
- package/docs/V1TimeWindowedAssetType.md +10 -0
- package/docs/V1Transformation.md +77 -0
- package/docs/V1UpdateNodeRequest.md +51 -0
- package/docs/V1VideoModeFramerateProperty.md +28 -0
- package/docs/V2CompleteObservationRequest.md +24 -0
- package/docs/V2NodeControllerIssueCertificateResponse.md +22 -0
- package/docs/V2UpdateNodeRequest.md +43 -0
- package/index.ts +1 -1
- package/package.json +4 -4
|
@@ -0,0 +1,3904 @@
|
|
|
1
|
+
# DefaultApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.prod.oursky.ai*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getCameraRoll**](#getcameraroll) | **GET** /v1/camera-roll | |
|
|
8
|
+
|[**getClientToken**](#getclienttoken) | **GET** /v1/client-tokens | |
|
|
9
|
+
|[**v1CameraMatch**](#v1cameramatch) | **GET** /v1/camera-match | |
|
|
10
|
+
|[**v1CompleteBootstrap**](#v1completebootstrap) | **POST** /v1/node-controller/completeBootstrap | |
|
|
11
|
+
|[**v1CompleteNodeControllerCrashReport**](#v1completenodecontrollercrashreport) | **POST** /v1/node-controller/complete-crash-report | |
|
|
12
|
+
|[**v1CompleteNodeFlare**](#v1completenodeflare) | **POST** /v1/node-flare/complete | |
|
|
13
|
+
|[**v1CompleteObservation**](#v1completeobservation) | **PUT** /v1/observation-complete | |
|
|
14
|
+
|[**v1CreateAllSkyPrediction**](#v1createallskyprediction) | **POST** /v1/all-sky-prediction | |
|
|
15
|
+
|[**v1CreateAutofocusResult**](#v1createautofocusresult) | **POST** /v1/autofocus | |
|
|
16
|
+
|[**v1CreateImageMetadata**](#v1createimagemetadata) | **POST** /v1/image-metadata | |
|
|
17
|
+
|[**v1CreateImageSet**](#v1createimageset) | **POST** /v1/image-set | |
|
|
18
|
+
|[**v1CreateImageSetImage**](#v1createimagesetimage) | **POST** /v1/image-set-image | |
|
|
19
|
+
|[**v1CreateImageSetImageUploadUrl**](#v1createimagesetimageuploadurl) | **POST** /v1/image-set-image/upload-url | |
|
|
20
|
+
|[**v1CreateMetrics**](#v1createmetrics) | **POST** /v1/metrics | |
|
|
21
|
+
|[**v1CreateNode**](#v1createnode) | **POST** /v1/node | |
|
|
22
|
+
|[**v1CreateNodeControllerArtifact**](#v1createnodecontrollerartifact) | **PUT** /v1/node-controller-artifact | |
|
|
23
|
+
|[**v1CreateNodeControllerCrashReport**](#v1createnodecontrollercrashreport) | **POST** /v1/node-controller/crash-report | |
|
|
24
|
+
|[**v1CreateNodeDiagnostics**](#v1createnodediagnostics) | **POST** /v1/node-diagnostics | |
|
|
25
|
+
|[**v1CreateNodeEvents**](#v1createnodeevents) | **POST** /v1/node-events | |
|
|
26
|
+
|[**v1CreateNodeFlare**](#v1createnodeflare) | **POST** /v1/node-flare | |
|
|
27
|
+
|[**v1CreateProcessedImageSetImage**](#v1createprocessedimagesetimage) | **POST** /v1/image-set-image/processed | |
|
|
28
|
+
|[**v1CreateTimeWindowedAsset**](#v1createtimewindowedasset) | **POST** /v1/time-windowed-asset | |
|
|
29
|
+
|[**v1CustomerGetSuntimes**](#v1customergetsuntimes) | **GET** /v1/suntimes | |
|
|
30
|
+
|[**v1DeleteImageSet**](#v1deleteimageset) | **DELETE** /v1/image-set | |
|
|
31
|
+
|[**v1DeleteImageSetImage**](#v1deleteimagesetimage) | **DELETE** /v1/image-set-image | |
|
|
32
|
+
|[**v1DeleteNodeCommand**](#v1deletenodecommand) | **DELETE** /v1/node-command | |
|
|
33
|
+
|[**v1DownloadCertificateBundle**](#v1downloadcertificatebundle) | **POST** /v1/node-controller/download-certificate-bundle | |
|
|
34
|
+
|[**v1FocuserMatch**](#v1focusermatch) | **GET** /v1/focuser-match | |
|
|
35
|
+
|[**v1GenerateEdgeToken**](#v1generateedgetoken) | **POST** /v1/edge-token | |
|
|
36
|
+
|[**v1GetAllSkyImageForImage**](#v1getallskyimageforimage) | **GET** /v1/all-sky-image-for-image | |
|
|
37
|
+
|[**v1GetAllSkyPrediction**](#v1getallskyprediction) | **GET** /v1/all-sky-prediction | |
|
|
38
|
+
|[**v1GetCameras**](#v1getcameras) | **GET** /v1/cameras | |
|
|
39
|
+
|[**v1GetImageMetadata**](#v1getimagemetadata) | **GET** /v1/image-metadata | |
|
|
40
|
+
|[**v1GetImageSet**](#v1getimageset) | **GET** /v1/image-set | |
|
|
41
|
+
|[**v1GetImageSetImage**](#v1getimagesetimage) | **GET** /v1/image-set-image | |
|
|
42
|
+
|[**v1GetInstruction**](#v1getinstruction) | **PUT** /v1/instruction | |
|
|
43
|
+
|[**v1GetLastInstructionByNodeId**](#v1getlastinstructionbynodeid) | **GET** /v1/instruction | |
|
|
44
|
+
|[**v1GetLatestHfr**](#v1getlatesthfr) | **GET** /v1/autofocus | |
|
|
45
|
+
|[**v1GetLatestModel**](#v1getlatestmodel) | **GET** /v1/ml/get-latest-model | |
|
|
46
|
+
|[**v1GetMergedNodeConfigBody**](#v1getmergednodeconfigbody) | **GET** /v1/node-config | |
|
|
47
|
+
|[**v1GetNode**](#v1getnode) | **GET** /v1/node | |
|
|
48
|
+
|[**v1GetNodeCommands**](#v1getnodecommands) | **GET** /v1/node-commands | |
|
|
49
|
+
|[**v1GetNodeDiagnosticTasks**](#v1getnodediagnostictasks) | **GET** /v1/node-diagnostic-tasks | |
|
|
50
|
+
|[**v1GetNodeEventsApexChartsTimeline**](#v1getnodeeventsapexchartstimeline) | **GET** /v1/node-events/timeline | |
|
|
51
|
+
|[**v1GetNodeFlare**](#v1getnodeflare) | **GET** /v1/node-flare/complete | |
|
|
52
|
+
|[**v1GetNodes**](#v1getnodes) | **GET** /v1/nodes | |
|
|
53
|
+
|[**v1GetOTAEncryption**](#v1getotaencryption) | **GET** /v1/encrypt-ota | |
|
|
54
|
+
|[**v1GetOpticalTube**](#v1getopticaltube) | **GET** /v1/optical-tube | |
|
|
55
|
+
|[**v1GetOrCreateCamera**](#v1getorcreatecamera) | **PUT** /v1/camera-match | |
|
|
56
|
+
|[**v1GetOrCreateFocuser**](#v1getorcreatefocuser) | **PUT** /v1/focuser-match | |
|
|
57
|
+
|[**v1GetOrCreateMount**](#v1getorcreatemount) | **PUT** /v1/mount-match | |
|
|
58
|
+
|[**v1GetPlateSolveCatalogDiff**](#v1getplatesolvecatalogdiff) | **PUT** /v1/plate-solve-catalog-diff | |
|
|
59
|
+
|[**v1GetSkyAtlasSatellites**](#v1getskyatlassatellites) | **GET** /v1/sky-atlas/satellites | |
|
|
60
|
+
|[**v1GetTargetQCOMOTASoftwareReleaseForNode**](#v1gettargetqcomotasoftwarereleasefornode) | **GET** /v1/node-controller-releases | |
|
|
61
|
+
|[**v1GetTargetSoftwareReleasesForNode**](#v1gettargetsoftwarereleasesfornode) | **GET** /v1/node/target-software-releases | |
|
|
62
|
+
|[**v1GetTimeWindowedAsset**](#v1gettimewindowedasset) | **GET** /v1/time-windowed-asset | |
|
|
63
|
+
|[**v1IssueCertificate**](#v1issuecertificate) | **POST** /v1/node-controller/issueCertificate | |
|
|
64
|
+
|[**v1Logout**](#v1logout) | **POST** /v1/logout | |
|
|
65
|
+
|[**v1MountMatch**](#v1mountmatch) | **GET** /v1/mount-match | |
|
|
66
|
+
|[**v1NodeCommandV1EnableAutonomousOperation**](#v1nodecommandv1enableautonomousoperation) | **POST** /v1/node-command/enable-autonomous-operation | |
|
|
67
|
+
|[**v1NodeCommandV1EnableManualOperation**](#v1nodecommandv1enablemanualoperation) | **POST** /v1/node-command/enable-manual-operation | |
|
|
68
|
+
|[**v1NodeCommandV1RebootSystem**](#v1nodecommandv1rebootsystem) | **POST** /v1/node-command/reboot | |
|
|
69
|
+
|[**v1NodeCommandV1SendFlare**](#v1nodecommandv1sendflare) | **POST** /v1/node-command/send-flare | |
|
|
70
|
+
|[**v1OAuthAuthorize**](#v1oauthauthorize) | **POST** /v1/oauth/authorize | |
|
|
71
|
+
|[**v1OAuthLogout**](#v1oauthlogout) | **POST** /v1/oauth/logout | |
|
|
72
|
+
|[**v1OAuthToken**](#v1oauthtoken) | **POST** /v1/oauth/token | |
|
|
73
|
+
|[**v1RefreshCertificate**](#v1refreshcertificate) | **POST** /v1/node-controller/refresh-certificate | |
|
|
74
|
+
|[**v1RegisterNodeController**](#v1registernodecontroller) | **POST** /v1/node-controller/register | |
|
|
75
|
+
|[**v1RequestMacAddresses**](#v1requestmacaddresses) | **POST** /v1/node-controller/request-mac-addresses | |
|
|
76
|
+
|[**v1StartOTAEncryptionLatest**](#v1startotaencryptionlatest) | **POST** /v1/encrypt-ota | |
|
|
77
|
+
|[**v1UpdateNode**](#v1updatenode) | **PUT** /v1/node | |
|
|
78
|
+
|[**v2CompleteObservation**](#v2completeobservation) | **PUT** /v2/observation-complete | |
|
|
79
|
+
|[**v2IssueCertificate**](#v2issuecertificate) | **POST** /v2/node-controller/issue-certificate | |
|
|
80
|
+
|[**v2UpdateNode**](#v2updatenode) | **PUT** /v2/node | |
|
|
81
|
+
|
|
82
|
+
# **getCameraRoll**
|
|
83
|
+
> Array<V1CameraRollImage> getCameraRoll()
|
|
84
|
+
|
|
85
|
+
Get images for a node for display in a camera roll format
|
|
86
|
+
|
|
87
|
+
### Example
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
import {
|
|
91
|
+
DefaultApi,
|
|
92
|
+
Configuration
|
|
93
|
+
} from '@ourskyai/platform-api';
|
|
94
|
+
|
|
95
|
+
const configuration = new Configuration();
|
|
96
|
+
const apiInstance = new DefaultApi(configuration);
|
|
97
|
+
|
|
98
|
+
let nodeId: string; // (optional) (default to undefined)
|
|
99
|
+
let lineageId: string; // (optional) (default to undefined)
|
|
100
|
+
let before: string; // (optional) (default to undefined)
|
|
101
|
+
let types: string; //Comma separated array of [ImageSetType](#model/imagesettype) (optional) (default to undefined)
|
|
102
|
+
|
|
103
|
+
const { status, data } = await apiInstance.getCameraRoll(
|
|
104
|
+
nodeId,
|
|
105
|
+
lineageId,
|
|
106
|
+
before,
|
|
107
|
+
types
|
|
108
|
+
);
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Parameters
|
|
112
|
+
|
|
113
|
+
|Name | Type | Description | Notes|
|
|
114
|
+
|------------- | ------------- | ------------- | -------------|
|
|
115
|
+
| **nodeId** | [**string**] | | (optional) defaults to undefined|
|
|
116
|
+
| **lineageId** | [**string**] | | (optional) defaults to undefined|
|
|
117
|
+
| **before** | [**string**] | | (optional) defaults to undefined|
|
|
118
|
+
| **types** | [**string**] | Comma separated array of [ImageSetType](#model/imagesettype) | (optional) defaults to undefined|
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
### Return type
|
|
122
|
+
|
|
123
|
+
**Array<V1CameraRollImage>**
|
|
124
|
+
|
|
125
|
+
### Authorization
|
|
126
|
+
|
|
127
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
128
|
+
|
|
129
|
+
### HTTP request headers
|
|
130
|
+
|
|
131
|
+
- **Content-Type**: Not defined
|
|
132
|
+
- **Accept**: application/json
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
### HTTP response details
|
|
136
|
+
| Status code | Description | Response headers |
|
|
137
|
+
|-------------|-------------|------------------|
|
|
138
|
+
|**200** | V1CameraRollImage[] | - |
|
|
139
|
+
|
|
140
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
141
|
+
|
|
142
|
+
# **getClientToken**
|
|
143
|
+
> V1ClientToken getClientToken()
|
|
144
|
+
|
|
145
|
+
Get the various tokens used in client applications
|
|
146
|
+
|
|
147
|
+
### Example
|
|
148
|
+
|
|
149
|
+
```typescript
|
|
150
|
+
import {
|
|
151
|
+
DefaultApi,
|
|
152
|
+
Configuration
|
|
153
|
+
} from '@ourskyai/platform-api';
|
|
154
|
+
|
|
155
|
+
const configuration = new Configuration();
|
|
156
|
+
const apiInstance = new DefaultApi(configuration);
|
|
157
|
+
|
|
158
|
+
const { status, data } = await apiInstance.getClientToken();
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Parameters
|
|
162
|
+
This endpoint does not have any parameters.
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
### Return type
|
|
166
|
+
|
|
167
|
+
**V1ClientToken**
|
|
168
|
+
|
|
169
|
+
### Authorization
|
|
170
|
+
|
|
171
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
172
|
+
|
|
173
|
+
### HTTP request headers
|
|
174
|
+
|
|
175
|
+
- **Content-Type**: Not defined
|
|
176
|
+
- **Accept**: application/json
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### HTTP response details
|
|
180
|
+
| Status code | Description | Response headers |
|
|
181
|
+
|-------------|-------------|------------------|
|
|
182
|
+
|**200** | ClientToken | - |
|
|
183
|
+
|
|
184
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
185
|
+
|
|
186
|
+
# **v1CameraMatch**
|
|
187
|
+
> Array<V1Camera> v1CameraMatch()
|
|
188
|
+
|
|
189
|
+
Match camera.
|
|
190
|
+
|
|
191
|
+
### Example
|
|
192
|
+
|
|
193
|
+
```typescript
|
|
194
|
+
import {
|
|
195
|
+
DefaultApi,
|
|
196
|
+
Configuration
|
|
197
|
+
} from '@ourskyai/platform-api';
|
|
198
|
+
|
|
199
|
+
const configuration = new Configuration();
|
|
200
|
+
const apiInstance = new DefaultApi(configuration);
|
|
201
|
+
|
|
202
|
+
let model: string; // (optional) (default to undefined)
|
|
203
|
+
let pixelSizeMicrons: number; // (optional) (default to undefined)
|
|
204
|
+
let pixelsX: number; // (optional) (default to undefined)
|
|
205
|
+
let pixelsY: number; // (optional) (default to undefined)
|
|
206
|
+
let megapixels: number; // (optional) (default to undefined)
|
|
207
|
+
let chilled: boolean; // (optional) (default to undefined)
|
|
208
|
+
let adcBitDepth: number; // (optional) (default to undefined)
|
|
209
|
+
let isColor: boolean; // (optional) (default to undefined)
|
|
210
|
+
|
|
211
|
+
const { status, data } = await apiInstance.v1CameraMatch(
|
|
212
|
+
model,
|
|
213
|
+
pixelSizeMicrons,
|
|
214
|
+
pixelsX,
|
|
215
|
+
pixelsY,
|
|
216
|
+
megapixels,
|
|
217
|
+
chilled,
|
|
218
|
+
adcBitDepth,
|
|
219
|
+
isColor
|
|
220
|
+
);
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
|Name | Type | Description | Notes|
|
|
226
|
+
|------------- | ------------- | ------------- | -------------|
|
|
227
|
+
| **model** | [**string**] | | (optional) defaults to undefined|
|
|
228
|
+
| **pixelSizeMicrons** | [**number**] | | (optional) defaults to undefined|
|
|
229
|
+
| **pixelsX** | [**number**] | | (optional) defaults to undefined|
|
|
230
|
+
| **pixelsY** | [**number**] | | (optional) defaults to undefined|
|
|
231
|
+
| **megapixels** | [**number**] | | (optional) defaults to undefined|
|
|
232
|
+
| **chilled** | [**boolean**] | | (optional) defaults to undefined|
|
|
233
|
+
| **adcBitDepth** | [**number**] | | (optional) defaults to undefined|
|
|
234
|
+
| **isColor** | [**boolean**] | | (optional) defaults to undefined|
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
### Return type
|
|
238
|
+
|
|
239
|
+
**Array<V1Camera>**
|
|
240
|
+
|
|
241
|
+
### Authorization
|
|
242
|
+
|
|
243
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
244
|
+
|
|
245
|
+
### HTTP request headers
|
|
246
|
+
|
|
247
|
+
- **Content-Type**: Not defined
|
|
248
|
+
- **Accept**: application/json
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
### HTTP response details
|
|
252
|
+
| Status code | Description | Response headers |
|
|
253
|
+
|-------------|-------------|------------------|
|
|
254
|
+
|**200** | V1Camera[] | - |
|
|
255
|
+
|
|
256
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
257
|
+
|
|
258
|
+
# **v1CompleteBootstrap**
|
|
259
|
+
> EmptySuccess v1CompleteBootstrap()
|
|
260
|
+
|
|
261
|
+
CompleteBootstrap
|
|
262
|
+
|
|
263
|
+
### Example
|
|
264
|
+
|
|
265
|
+
```typescript
|
|
266
|
+
import {
|
|
267
|
+
DefaultApi,
|
|
268
|
+
Configuration
|
|
269
|
+
} from '@ourskyai/platform-api';
|
|
270
|
+
|
|
271
|
+
const configuration = new Configuration();
|
|
272
|
+
const apiInstance = new DefaultApi(configuration);
|
|
273
|
+
|
|
274
|
+
const { status, data } = await apiInstance.v1CompleteBootstrap();
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### Parameters
|
|
278
|
+
This endpoint does not have any parameters.
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
### Return type
|
|
282
|
+
|
|
283
|
+
**EmptySuccess**
|
|
284
|
+
|
|
285
|
+
### Authorization
|
|
286
|
+
|
|
287
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
288
|
+
|
|
289
|
+
### HTTP request headers
|
|
290
|
+
|
|
291
|
+
- **Content-Type**: Not defined
|
|
292
|
+
- **Accept**: application/json
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
### HTTP response details
|
|
296
|
+
| Status code | Description | Response headers |
|
|
297
|
+
|-------------|-------------|------------------|
|
|
298
|
+
|**200** | Successful action | - |
|
|
299
|
+
|
|
300
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
301
|
+
|
|
302
|
+
# **v1CompleteNodeControllerCrashReport**
|
|
303
|
+
> EmptySuccess v1CompleteNodeControllerCrashReport(v1CompleteNodeControllerCrashReportRequest)
|
|
304
|
+
|
|
305
|
+
Complete a crash report.
|
|
306
|
+
|
|
307
|
+
### Example
|
|
308
|
+
|
|
309
|
+
```typescript
|
|
310
|
+
import {
|
|
311
|
+
DefaultApi,
|
|
312
|
+
Configuration,
|
|
313
|
+
V1CompleteNodeControllerCrashReportRequest
|
|
314
|
+
} from '@ourskyai/platform-api';
|
|
315
|
+
|
|
316
|
+
const configuration = new Configuration();
|
|
317
|
+
const apiInstance = new DefaultApi(configuration);
|
|
318
|
+
|
|
319
|
+
let v1CompleteNodeControllerCrashReportRequest: V1CompleteNodeControllerCrashReportRequest; //
|
|
320
|
+
|
|
321
|
+
const { status, data } = await apiInstance.v1CompleteNodeControllerCrashReport(
|
|
322
|
+
v1CompleteNodeControllerCrashReportRequest
|
|
323
|
+
);
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
### Parameters
|
|
327
|
+
|
|
328
|
+
|Name | Type | Description | Notes|
|
|
329
|
+
|------------- | ------------- | ------------- | -------------|
|
|
330
|
+
| **v1CompleteNodeControllerCrashReportRequest** | **V1CompleteNodeControllerCrashReportRequest**| | |
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
### Return type
|
|
334
|
+
|
|
335
|
+
**EmptySuccess**
|
|
336
|
+
|
|
337
|
+
### Authorization
|
|
338
|
+
|
|
339
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
340
|
+
|
|
341
|
+
### HTTP request headers
|
|
342
|
+
|
|
343
|
+
- **Content-Type**: application/json
|
|
344
|
+
- **Accept**: application/json
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
### HTTP response details
|
|
348
|
+
| Status code | Description | Response headers |
|
|
349
|
+
|-------------|-------------|------------------|
|
|
350
|
+
|**200** | Successful action | - |
|
|
351
|
+
|
|
352
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
353
|
+
|
|
354
|
+
# **v1CompleteNodeFlare**
|
|
355
|
+
> EmptySuccess v1CompleteNodeFlare(v1CompleteNodeFlareRequest)
|
|
356
|
+
|
|
357
|
+
Complete a node flare.
|
|
358
|
+
|
|
359
|
+
### Example
|
|
360
|
+
|
|
361
|
+
```typescript
|
|
362
|
+
import {
|
|
363
|
+
DefaultApi,
|
|
364
|
+
Configuration,
|
|
365
|
+
V1CompleteNodeFlareRequest
|
|
366
|
+
} from '@ourskyai/platform-api';
|
|
367
|
+
|
|
368
|
+
const configuration = new Configuration();
|
|
369
|
+
const apiInstance = new DefaultApi(configuration);
|
|
370
|
+
|
|
371
|
+
let v1CompleteNodeFlareRequest: V1CompleteNodeFlareRequest; //
|
|
372
|
+
|
|
373
|
+
const { status, data } = await apiInstance.v1CompleteNodeFlare(
|
|
374
|
+
v1CompleteNodeFlareRequest
|
|
375
|
+
);
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
### Parameters
|
|
379
|
+
|
|
380
|
+
|Name | Type | Description | Notes|
|
|
381
|
+
|------------- | ------------- | ------------- | -------------|
|
|
382
|
+
| **v1CompleteNodeFlareRequest** | **V1CompleteNodeFlareRequest**| | |
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
### Return type
|
|
386
|
+
|
|
387
|
+
**EmptySuccess**
|
|
388
|
+
|
|
389
|
+
### Authorization
|
|
390
|
+
|
|
391
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
392
|
+
|
|
393
|
+
### HTTP request headers
|
|
394
|
+
|
|
395
|
+
- **Content-Type**: application/json
|
|
396
|
+
- **Accept**: application/json
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
### HTTP response details
|
|
400
|
+
| Status code | Description | Response headers |
|
|
401
|
+
|-------------|-------------|------------------|
|
|
402
|
+
|**200** | Successful action | - |
|
|
403
|
+
|
|
404
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
405
|
+
|
|
406
|
+
# **v1CompleteObservation**
|
|
407
|
+
> EmptySuccess v1CompleteObservation(v1CompleteObservationRequest)
|
|
408
|
+
|
|
409
|
+
Complete an observation.
|
|
410
|
+
|
|
411
|
+
### Example
|
|
412
|
+
|
|
413
|
+
```typescript
|
|
414
|
+
import {
|
|
415
|
+
DefaultApi,
|
|
416
|
+
Configuration,
|
|
417
|
+
V1CompleteObservationRequest
|
|
418
|
+
} from '@ourskyai/platform-api';
|
|
419
|
+
|
|
420
|
+
const configuration = new Configuration();
|
|
421
|
+
const apiInstance = new DefaultApi(configuration);
|
|
422
|
+
|
|
423
|
+
let v1CompleteObservationRequest: V1CompleteObservationRequest; //
|
|
424
|
+
|
|
425
|
+
const { status, data } = await apiInstance.v1CompleteObservation(
|
|
426
|
+
v1CompleteObservationRequest
|
|
427
|
+
);
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
### Parameters
|
|
431
|
+
|
|
432
|
+
|Name | Type | Description | Notes|
|
|
433
|
+
|------------- | ------------- | ------------- | -------------|
|
|
434
|
+
| **v1CompleteObservationRequest** | **V1CompleteObservationRequest**| | |
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
### Return type
|
|
438
|
+
|
|
439
|
+
**EmptySuccess**
|
|
440
|
+
|
|
441
|
+
### Authorization
|
|
442
|
+
|
|
443
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
444
|
+
|
|
445
|
+
### HTTP request headers
|
|
446
|
+
|
|
447
|
+
- **Content-Type**: application/json
|
|
448
|
+
- **Accept**: application/json
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
### HTTP response details
|
|
452
|
+
| Status code | Description | Response headers |
|
|
453
|
+
|-------------|-------------|------------------|
|
|
454
|
+
|**200** | Successful action | - |
|
|
455
|
+
|
|
456
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
457
|
+
|
|
458
|
+
# **v1CreateAllSkyPrediction**
|
|
459
|
+
> V1AllSkyPrediction v1CreateAllSkyPrediction(v1CreateAllSkyPredictionRequest)
|
|
460
|
+
|
|
461
|
+
Create a new all sky prediction
|
|
462
|
+
|
|
463
|
+
### Example
|
|
464
|
+
|
|
465
|
+
```typescript
|
|
466
|
+
import {
|
|
467
|
+
DefaultApi,
|
|
468
|
+
Configuration,
|
|
469
|
+
V1CreateAllSkyPredictionRequest
|
|
470
|
+
} from '@ourskyai/platform-api';
|
|
471
|
+
|
|
472
|
+
const configuration = new Configuration();
|
|
473
|
+
const apiInstance = new DefaultApi(configuration);
|
|
474
|
+
|
|
475
|
+
let v1CreateAllSkyPredictionRequest: V1CreateAllSkyPredictionRequest; //
|
|
476
|
+
|
|
477
|
+
const { status, data } = await apiInstance.v1CreateAllSkyPrediction(
|
|
478
|
+
v1CreateAllSkyPredictionRequest
|
|
479
|
+
);
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
### Parameters
|
|
483
|
+
|
|
484
|
+
|Name | Type | Description | Notes|
|
|
485
|
+
|------------- | ------------- | ------------- | -------------|
|
|
486
|
+
| **v1CreateAllSkyPredictionRequest** | **V1CreateAllSkyPredictionRequest**| | |
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
### Return type
|
|
490
|
+
|
|
491
|
+
**V1AllSkyPrediction**
|
|
492
|
+
|
|
493
|
+
### Authorization
|
|
494
|
+
|
|
495
|
+
No authorization required
|
|
496
|
+
|
|
497
|
+
### HTTP request headers
|
|
498
|
+
|
|
499
|
+
- **Content-Type**: application/json
|
|
500
|
+
- **Accept**: application/json
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
### HTTP response details
|
|
504
|
+
| Status code | Description | Response headers |
|
|
505
|
+
|-------------|-------------|------------------|
|
|
506
|
+
|**201** | All Sky prediction created successfully | - |
|
|
507
|
+
|
|
508
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
509
|
+
|
|
510
|
+
# **v1CreateAutofocusResult**
|
|
511
|
+
> SuccessfulCreate v1CreateAutofocusResult(v1CreateAutofocusResultRequest)
|
|
512
|
+
|
|
513
|
+
Create an autofocus result.
|
|
514
|
+
|
|
515
|
+
### Example
|
|
516
|
+
|
|
517
|
+
```typescript
|
|
518
|
+
import {
|
|
519
|
+
DefaultApi,
|
|
520
|
+
Configuration,
|
|
521
|
+
V1CreateAutofocusResultRequest
|
|
522
|
+
} from '@ourskyai/platform-api';
|
|
523
|
+
|
|
524
|
+
const configuration = new Configuration();
|
|
525
|
+
const apiInstance = new DefaultApi(configuration);
|
|
526
|
+
|
|
527
|
+
let v1CreateAutofocusResultRequest: V1CreateAutofocusResultRequest; //
|
|
528
|
+
|
|
529
|
+
const { status, data } = await apiInstance.v1CreateAutofocusResult(
|
|
530
|
+
v1CreateAutofocusResultRequest
|
|
531
|
+
);
|
|
532
|
+
```
|
|
533
|
+
|
|
534
|
+
### Parameters
|
|
535
|
+
|
|
536
|
+
|Name | Type | Description | Notes|
|
|
537
|
+
|------------- | ------------- | ------------- | -------------|
|
|
538
|
+
| **v1CreateAutofocusResultRequest** | **V1CreateAutofocusResultRequest**| | |
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
### Return type
|
|
542
|
+
|
|
543
|
+
**SuccessfulCreate**
|
|
544
|
+
|
|
545
|
+
### Authorization
|
|
546
|
+
|
|
547
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
548
|
+
|
|
549
|
+
### HTTP request headers
|
|
550
|
+
|
|
551
|
+
- **Content-Type**: application/json
|
|
552
|
+
- **Accept**: application/json
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
### HTTP response details
|
|
556
|
+
| Status code | Description | Response headers |
|
|
557
|
+
|-------------|-------------|------------------|
|
|
558
|
+
|**200** | Successful create | - |
|
|
559
|
+
|
|
560
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
561
|
+
|
|
562
|
+
# **v1CreateImageMetadata**
|
|
563
|
+
> EmptySuccess v1CreateImageMetadata(v1CreateImageMetadataRequest)
|
|
564
|
+
|
|
565
|
+
Create metadata about an image by image id. This includes plate solve results
|
|
566
|
+
|
|
567
|
+
### Example
|
|
568
|
+
|
|
569
|
+
```typescript
|
|
570
|
+
import {
|
|
571
|
+
DefaultApi,
|
|
572
|
+
Configuration,
|
|
573
|
+
V1CreateImageMetadataRequest
|
|
574
|
+
} from '@ourskyai/platform-api';
|
|
575
|
+
|
|
576
|
+
const configuration = new Configuration();
|
|
577
|
+
const apiInstance = new DefaultApi(configuration);
|
|
578
|
+
|
|
579
|
+
let imageId: string; // (default to undefined)
|
|
580
|
+
let v1CreateImageMetadataRequest: V1CreateImageMetadataRequest; //
|
|
581
|
+
|
|
582
|
+
const { status, data } = await apiInstance.v1CreateImageMetadata(
|
|
583
|
+
imageId,
|
|
584
|
+
v1CreateImageMetadataRequest
|
|
585
|
+
);
|
|
586
|
+
```
|
|
587
|
+
|
|
588
|
+
### Parameters
|
|
589
|
+
|
|
590
|
+
|Name | Type | Description | Notes|
|
|
591
|
+
|------------- | ------------- | ------------- | -------------|
|
|
592
|
+
| **v1CreateImageMetadataRequest** | **V1CreateImageMetadataRequest**| | |
|
|
593
|
+
| **imageId** | [**string**] | | defaults to undefined|
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
### Return type
|
|
597
|
+
|
|
598
|
+
**EmptySuccess**
|
|
599
|
+
|
|
600
|
+
### Authorization
|
|
601
|
+
|
|
602
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
603
|
+
|
|
604
|
+
### HTTP request headers
|
|
605
|
+
|
|
606
|
+
- **Content-Type**: application/json
|
|
607
|
+
- **Accept**: application/json
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
### HTTP response details
|
|
611
|
+
| Status code | Description | Response headers |
|
|
612
|
+
|-------------|-------------|------------------|
|
|
613
|
+
|**200** | Successful action | - |
|
|
614
|
+
|
|
615
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
616
|
+
|
|
617
|
+
# **v1CreateImageSet**
|
|
618
|
+
> SuccessfulCreate v1CreateImageSet(v1CreateImageSetRequest)
|
|
619
|
+
|
|
620
|
+
Create an image set.
|
|
621
|
+
|
|
622
|
+
### Example
|
|
623
|
+
|
|
624
|
+
```typescript
|
|
625
|
+
import {
|
|
626
|
+
DefaultApi,
|
|
627
|
+
Configuration,
|
|
628
|
+
V1CreateImageSetRequest
|
|
629
|
+
} from '@ourskyai/platform-api';
|
|
630
|
+
|
|
631
|
+
const configuration = new Configuration();
|
|
632
|
+
const apiInstance = new DefaultApi(configuration);
|
|
633
|
+
|
|
634
|
+
let v1CreateImageSetRequest: V1CreateImageSetRequest; //
|
|
635
|
+
|
|
636
|
+
const { status, data } = await apiInstance.v1CreateImageSet(
|
|
637
|
+
v1CreateImageSetRequest
|
|
638
|
+
);
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
### Parameters
|
|
642
|
+
|
|
643
|
+
|Name | Type | Description | Notes|
|
|
644
|
+
|------------- | ------------- | ------------- | -------------|
|
|
645
|
+
| **v1CreateImageSetRequest** | **V1CreateImageSetRequest**| | |
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
### Return type
|
|
649
|
+
|
|
650
|
+
**SuccessfulCreate**
|
|
651
|
+
|
|
652
|
+
### Authorization
|
|
653
|
+
|
|
654
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
655
|
+
|
|
656
|
+
### HTTP request headers
|
|
657
|
+
|
|
658
|
+
- **Content-Type**: application/json
|
|
659
|
+
- **Accept**: application/json
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
### HTTP response details
|
|
663
|
+
| Status code | Description | Response headers |
|
|
664
|
+
|-------------|-------------|------------------|
|
|
665
|
+
|**200** | Successful create | - |
|
|
666
|
+
|
|
667
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
668
|
+
|
|
669
|
+
# **v1CreateImageSetImage**
|
|
670
|
+
> V1CreateImageSetImageResponse v1CreateImageSetImage(v1CreateImageSetImageRequest)
|
|
671
|
+
|
|
672
|
+
Create an image set image.
|
|
673
|
+
|
|
674
|
+
### Example
|
|
675
|
+
|
|
676
|
+
```typescript
|
|
677
|
+
import {
|
|
678
|
+
DefaultApi,
|
|
679
|
+
Configuration,
|
|
680
|
+
V1CreateImageSetImageRequest
|
|
681
|
+
} from '@ourskyai/platform-api';
|
|
682
|
+
|
|
683
|
+
const configuration = new Configuration();
|
|
684
|
+
const apiInstance = new DefaultApi(configuration);
|
|
685
|
+
|
|
686
|
+
let v1CreateImageSetImageRequest: V1CreateImageSetImageRequest; //
|
|
687
|
+
|
|
688
|
+
const { status, data } = await apiInstance.v1CreateImageSetImage(
|
|
689
|
+
v1CreateImageSetImageRequest
|
|
690
|
+
);
|
|
691
|
+
```
|
|
692
|
+
|
|
693
|
+
### Parameters
|
|
694
|
+
|
|
695
|
+
|Name | Type | Description | Notes|
|
|
696
|
+
|------------- | ------------- | ------------- | -------------|
|
|
697
|
+
| **v1CreateImageSetImageRequest** | **V1CreateImageSetImageRequest**| | |
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
### Return type
|
|
701
|
+
|
|
702
|
+
**V1CreateImageSetImageResponse**
|
|
703
|
+
|
|
704
|
+
### Authorization
|
|
705
|
+
|
|
706
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
707
|
+
|
|
708
|
+
### HTTP request headers
|
|
709
|
+
|
|
710
|
+
- **Content-Type**: application/json
|
|
711
|
+
- **Accept**: application/json
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
### HTTP response details
|
|
715
|
+
| Status code | Description | Response headers |
|
|
716
|
+
|-------------|-------------|------------------|
|
|
717
|
+
|**200** | V1CreateImageSetImageResponse | - |
|
|
718
|
+
|
|
719
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
720
|
+
|
|
721
|
+
# **v1CreateImageSetImageUploadUrl**
|
|
722
|
+
> V1CreateImageSetImageUploadUrlResponse v1CreateImageSetImageUploadUrl(v1CreateImageSetImageUploadUrlRequest)
|
|
723
|
+
|
|
724
|
+
Create an image set image upload url.
|
|
725
|
+
|
|
726
|
+
### Example
|
|
727
|
+
|
|
728
|
+
```typescript
|
|
729
|
+
import {
|
|
730
|
+
DefaultApi,
|
|
731
|
+
Configuration,
|
|
732
|
+
V1CreateImageSetImageUploadUrlRequest
|
|
733
|
+
} from '@ourskyai/platform-api';
|
|
734
|
+
|
|
735
|
+
const configuration = new Configuration();
|
|
736
|
+
const apiInstance = new DefaultApi(configuration);
|
|
737
|
+
|
|
738
|
+
let v1CreateImageSetImageUploadUrlRequest: V1CreateImageSetImageUploadUrlRequest; //
|
|
739
|
+
|
|
740
|
+
const { status, data } = await apiInstance.v1CreateImageSetImageUploadUrl(
|
|
741
|
+
v1CreateImageSetImageUploadUrlRequest
|
|
742
|
+
);
|
|
743
|
+
```
|
|
744
|
+
|
|
745
|
+
### Parameters
|
|
746
|
+
|
|
747
|
+
|Name | Type | Description | Notes|
|
|
748
|
+
|------------- | ------------- | ------------- | -------------|
|
|
749
|
+
| **v1CreateImageSetImageUploadUrlRequest** | **V1CreateImageSetImageUploadUrlRequest**| | |
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
### Return type
|
|
753
|
+
|
|
754
|
+
**V1CreateImageSetImageUploadUrlResponse**
|
|
755
|
+
|
|
756
|
+
### Authorization
|
|
757
|
+
|
|
758
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
759
|
+
|
|
760
|
+
### HTTP request headers
|
|
761
|
+
|
|
762
|
+
- **Content-Type**: application/json
|
|
763
|
+
- **Accept**: application/json
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
### HTTP response details
|
|
767
|
+
| Status code | Description | Response headers |
|
|
768
|
+
|-------------|-------------|------------------|
|
|
769
|
+
|**200** | V1CreateImageSetImageUploadUrlResponse | - |
|
|
770
|
+
|
|
771
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
772
|
+
|
|
773
|
+
# **v1CreateMetrics**
|
|
774
|
+
> EmptySuccess v1CreateMetrics(v1Metric)
|
|
775
|
+
|
|
776
|
+
Create metrics.
|
|
777
|
+
|
|
778
|
+
### Example
|
|
779
|
+
|
|
780
|
+
```typescript
|
|
781
|
+
import {
|
|
782
|
+
DefaultApi,
|
|
783
|
+
Configuration
|
|
784
|
+
} from '@ourskyai/platform-api';
|
|
785
|
+
|
|
786
|
+
const configuration = new Configuration();
|
|
787
|
+
const apiInstance = new DefaultApi(configuration);
|
|
788
|
+
|
|
789
|
+
let v1Metric: Array<V1Metric>; //
|
|
790
|
+
|
|
791
|
+
const { status, data } = await apiInstance.v1CreateMetrics(
|
|
792
|
+
v1Metric
|
|
793
|
+
);
|
|
794
|
+
```
|
|
795
|
+
|
|
796
|
+
### Parameters
|
|
797
|
+
|
|
798
|
+
|Name | Type | Description | Notes|
|
|
799
|
+
|------------- | ------------- | ------------- | -------------|
|
|
800
|
+
| **v1Metric** | **Array<V1Metric>**| | |
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
### Return type
|
|
804
|
+
|
|
805
|
+
**EmptySuccess**
|
|
806
|
+
|
|
807
|
+
### Authorization
|
|
808
|
+
|
|
809
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
810
|
+
|
|
811
|
+
### HTTP request headers
|
|
812
|
+
|
|
813
|
+
- **Content-Type**: application/json
|
|
814
|
+
- **Accept**: application/json
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
### HTTP response details
|
|
818
|
+
| Status code | Description | Response headers |
|
|
819
|
+
|-------------|-------------|------------------|
|
|
820
|
+
|**200** | Successful action | - |
|
|
821
|
+
|
|
822
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
823
|
+
|
|
824
|
+
# **v1CreateNode**
|
|
825
|
+
> SuccessfulCreate v1CreateNode(v1CreateNodeRequest)
|
|
826
|
+
|
|
827
|
+
Create a node.
|
|
828
|
+
|
|
829
|
+
### Example
|
|
830
|
+
|
|
831
|
+
```typescript
|
|
832
|
+
import {
|
|
833
|
+
DefaultApi,
|
|
834
|
+
Configuration,
|
|
835
|
+
V1CreateNodeRequest
|
|
836
|
+
} from '@ourskyai/platform-api';
|
|
837
|
+
|
|
838
|
+
const configuration = new Configuration();
|
|
839
|
+
const apiInstance = new DefaultApi(configuration);
|
|
840
|
+
|
|
841
|
+
let v1CreateNodeRequest: V1CreateNodeRequest; //
|
|
842
|
+
|
|
843
|
+
const { status, data } = await apiInstance.v1CreateNode(
|
|
844
|
+
v1CreateNodeRequest
|
|
845
|
+
);
|
|
846
|
+
```
|
|
847
|
+
|
|
848
|
+
### Parameters
|
|
849
|
+
|
|
850
|
+
|Name | Type | Description | Notes|
|
|
851
|
+
|------------- | ------------- | ------------- | -------------|
|
|
852
|
+
| **v1CreateNodeRequest** | **V1CreateNodeRequest**| | |
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
### Return type
|
|
856
|
+
|
|
857
|
+
**SuccessfulCreate**
|
|
858
|
+
|
|
859
|
+
### Authorization
|
|
860
|
+
|
|
861
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
862
|
+
|
|
863
|
+
### HTTP request headers
|
|
864
|
+
|
|
865
|
+
- **Content-Type**: application/json
|
|
866
|
+
- **Accept**: application/json
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
### HTTP response details
|
|
870
|
+
| Status code | Description | Response headers |
|
|
871
|
+
|-------------|-------------|------------------|
|
|
872
|
+
|**200** | Successful create | - |
|
|
873
|
+
|
|
874
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
875
|
+
|
|
876
|
+
# **v1CreateNodeControllerArtifact**
|
|
877
|
+
> V1NodeControllerArtifact v1CreateNodeControllerArtifact(v1CreateNodeControllerArtifactRequest)
|
|
878
|
+
|
|
879
|
+
Create a node controller artifact.
|
|
880
|
+
|
|
881
|
+
### Example
|
|
882
|
+
|
|
883
|
+
```typescript
|
|
884
|
+
import {
|
|
885
|
+
DefaultApi,
|
|
886
|
+
Configuration,
|
|
887
|
+
V1CreateNodeControllerArtifactRequest
|
|
888
|
+
} from '@ourskyai/platform-api';
|
|
889
|
+
|
|
890
|
+
const configuration = new Configuration();
|
|
891
|
+
const apiInstance = new DefaultApi(configuration);
|
|
892
|
+
|
|
893
|
+
let v1CreateNodeControllerArtifactRequest: V1CreateNodeControllerArtifactRequest; //
|
|
894
|
+
|
|
895
|
+
const { status, data } = await apiInstance.v1CreateNodeControllerArtifact(
|
|
896
|
+
v1CreateNodeControllerArtifactRequest
|
|
897
|
+
);
|
|
898
|
+
```
|
|
899
|
+
|
|
900
|
+
### Parameters
|
|
901
|
+
|
|
902
|
+
|Name | Type | Description | Notes|
|
|
903
|
+
|------------- | ------------- | ------------- | -------------|
|
|
904
|
+
| **v1CreateNodeControllerArtifactRequest** | **V1CreateNodeControllerArtifactRequest**| | |
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
### Return type
|
|
908
|
+
|
|
909
|
+
**V1NodeControllerArtifact**
|
|
910
|
+
|
|
911
|
+
### Authorization
|
|
912
|
+
|
|
913
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
914
|
+
|
|
915
|
+
### HTTP request headers
|
|
916
|
+
|
|
917
|
+
- **Content-Type**: application/json
|
|
918
|
+
- **Accept**: application/json
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
### HTTP response details
|
|
922
|
+
| Status code | Description | Response headers |
|
|
923
|
+
|-------------|-------------|------------------|
|
|
924
|
+
|**200** | V1NodeControllerArtifact | - |
|
|
925
|
+
|
|
926
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
927
|
+
|
|
928
|
+
# **v1CreateNodeControllerCrashReport**
|
|
929
|
+
> V1CreateNodeControllerCrashReportResponse v1CreateNodeControllerCrashReport(v1CreateNodeControllerCrashReportRequest)
|
|
930
|
+
|
|
931
|
+
create a crash report record
|
|
932
|
+
|
|
933
|
+
### Example
|
|
934
|
+
|
|
935
|
+
```typescript
|
|
936
|
+
import {
|
|
937
|
+
DefaultApi,
|
|
938
|
+
Configuration,
|
|
939
|
+
V1CreateNodeControllerCrashReportRequest
|
|
940
|
+
} from '@ourskyai/platform-api';
|
|
941
|
+
|
|
942
|
+
const configuration = new Configuration();
|
|
943
|
+
const apiInstance = new DefaultApi(configuration);
|
|
944
|
+
|
|
945
|
+
let v1CreateNodeControllerCrashReportRequest: V1CreateNodeControllerCrashReportRequest; //
|
|
946
|
+
|
|
947
|
+
const { status, data } = await apiInstance.v1CreateNodeControllerCrashReport(
|
|
948
|
+
v1CreateNodeControllerCrashReportRequest
|
|
949
|
+
);
|
|
950
|
+
```
|
|
951
|
+
|
|
952
|
+
### Parameters
|
|
953
|
+
|
|
954
|
+
|Name | Type | Description | Notes|
|
|
955
|
+
|------------- | ------------- | ------------- | -------------|
|
|
956
|
+
| **v1CreateNodeControllerCrashReportRequest** | **V1CreateNodeControllerCrashReportRequest**| | |
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
### Return type
|
|
960
|
+
|
|
961
|
+
**V1CreateNodeControllerCrashReportResponse**
|
|
962
|
+
|
|
963
|
+
### Authorization
|
|
964
|
+
|
|
965
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
966
|
+
|
|
967
|
+
### HTTP request headers
|
|
968
|
+
|
|
969
|
+
- **Content-Type**: application/json
|
|
970
|
+
- **Accept**: application/json
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
### HTTP response details
|
|
974
|
+
| Status code | Description | Response headers |
|
|
975
|
+
|-------------|-------------|------------------|
|
|
976
|
+
|**200** | V1CreateNodeControllerCrashReportResponse | - |
|
|
977
|
+
|
|
978
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
979
|
+
|
|
980
|
+
# **v1CreateNodeDiagnostics**
|
|
981
|
+
> EmptySuccess v1CreateNodeDiagnostics(v1CreateNodeDiagnosticsRequest)
|
|
982
|
+
|
|
983
|
+
Create node diagnostics.
|
|
984
|
+
|
|
985
|
+
### Example
|
|
986
|
+
|
|
987
|
+
```typescript
|
|
988
|
+
import {
|
|
989
|
+
DefaultApi,
|
|
990
|
+
Configuration,
|
|
991
|
+
V1CreateNodeDiagnosticsRequest
|
|
992
|
+
} from '@ourskyai/platform-api';
|
|
993
|
+
|
|
994
|
+
const configuration = new Configuration();
|
|
995
|
+
const apiInstance = new DefaultApi(configuration);
|
|
996
|
+
|
|
997
|
+
let v1CreateNodeDiagnosticsRequest: V1CreateNodeDiagnosticsRequest; //
|
|
998
|
+
|
|
999
|
+
const { status, data } = await apiInstance.v1CreateNodeDiagnostics(
|
|
1000
|
+
v1CreateNodeDiagnosticsRequest
|
|
1001
|
+
);
|
|
1002
|
+
```
|
|
1003
|
+
|
|
1004
|
+
### Parameters
|
|
1005
|
+
|
|
1006
|
+
|Name | Type | Description | Notes|
|
|
1007
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1008
|
+
| **v1CreateNodeDiagnosticsRequest** | **V1CreateNodeDiagnosticsRequest**| | |
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
### Return type
|
|
1012
|
+
|
|
1013
|
+
**EmptySuccess**
|
|
1014
|
+
|
|
1015
|
+
### Authorization
|
|
1016
|
+
|
|
1017
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1018
|
+
|
|
1019
|
+
### HTTP request headers
|
|
1020
|
+
|
|
1021
|
+
- **Content-Type**: application/json
|
|
1022
|
+
- **Accept**: application/json
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
### HTTP response details
|
|
1026
|
+
| Status code | Description | Response headers |
|
|
1027
|
+
|-------------|-------------|------------------|
|
|
1028
|
+
|**200** | Successful action | - |
|
|
1029
|
+
|
|
1030
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1031
|
+
|
|
1032
|
+
# **v1CreateNodeEvents**
|
|
1033
|
+
> EmptySuccess v1CreateNodeEvents(v1CreateNodeEventsRequest)
|
|
1034
|
+
|
|
1035
|
+
Create node events
|
|
1036
|
+
|
|
1037
|
+
### Example
|
|
1038
|
+
|
|
1039
|
+
```typescript
|
|
1040
|
+
import {
|
|
1041
|
+
DefaultApi,
|
|
1042
|
+
Configuration,
|
|
1043
|
+
V1CreateNodeEventsRequest
|
|
1044
|
+
} from '@ourskyai/platform-api';
|
|
1045
|
+
|
|
1046
|
+
const configuration = new Configuration();
|
|
1047
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1048
|
+
|
|
1049
|
+
let v1CreateNodeEventsRequest: V1CreateNodeEventsRequest; //
|
|
1050
|
+
|
|
1051
|
+
const { status, data } = await apiInstance.v1CreateNodeEvents(
|
|
1052
|
+
v1CreateNodeEventsRequest
|
|
1053
|
+
);
|
|
1054
|
+
```
|
|
1055
|
+
|
|
1056
|
+
### Parameters
|
|
1057
|
+
|
|
1058
|
+
|Name | Type | Description | Notes|
|
|
1059
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1060
|
+
| **v1CreateNodeEventsRequest** | **V1CreateNodeEventsRequest**| | |
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
### Return type
|
|
1064
|
+
|
|
1065
|
+
**EmptySuccess**
|
|
1066
|
+
|
|
1067
|
+
### Authorization
|
|
1068
|
+
|
|
1069
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1070
|
+
|
|
1071
|
+
### HTTP request headers
|
|
1072
|
+
|
|
1073
|
+
- **Content-Type**: application/json
|
|
1074
|
+
- **Accept**: application/json
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
### HTTP response details
|
|
1078
|
+
| Status code | Description | Response headers |
|
|
1079
|
+
|-------------|-------------|------------------|
|
|
1080
|
+
|**200** | Successful action | - |
|
|
1081
|
+
|
|
1082
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1083
|
+
|
|
1084
|
+
# **v1CreateNodeFlare**
|
|
1085
|
+
> V1CreateNodeFlareResponse v1CreateNodeFlare(v1CreateNodeFlareRequest)
|
|
1086
|
+
|
|
1087
|
+
Create a node flare.
|
|
1088
|
+
|
|
1089
|
+
### Example
|
|
1090
|
+
|
|
1091
|
+
```typescript
|
|
1092
|
+
import {
|
|
1093
|
+
DefaultApi,
|
|
1094
|
+
Configuration,
|
|
1095
|
+
V1CreateNodeFlareRequest
|
|
1096
|
+
} from '@ourskyai/platform-api';
|
|
1097
|
+
|
|
1098
|
+
const configuration = new Configuration();
|
|
1099
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1100
|
+
|
|
1101
|
+
let v1CreateNodeFlareRequest: V1CreateNodeFlareRequest; //
|
|
1102
|
+
|
|
1103
|
+
const { status, data } = await apiInstance.v1CreateNodeFlare(
|
|
1104
|
+
v1CreateNodeFlareRequest
|
|
1105
|
+
);
|
|
1106
|
+
```
|
|
1107
|
+
|
|
1108
|
+
### Parameters
|
|
1109
|
+
|
|
1110
|
+
|Name | Type | Description | Notes|
|
|
1111
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1112
|
+
| **v1CreateNodeFlareRequest** | **V1CreateNodeFlareRequest**| | |
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
### Return type
|
|
1116
|
+
|
|
1117
|
+
**V1CreateNodeFlareResponse**
|
|
1118
|
+
|
|
1119
|
+
### Authorization
|
|
1120
|
+
|
|
1121
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1122
|
+
|
|
1123
|
+
### HTTP request headers
|
|
1124
|
+
|
|
1125
|
+
- **Content-Type**: application/json
|
|
1126
|
+
- **Accept**: application/json
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
### HTTP response details
|
|
1130
|
+
| Status code | Description | Response headers |
|
|
1131
|
+
|-------------|-------------|------------------|
|
|
1132
|
+
|**200** | V1CreateNodeFlareResponse | - |
|
|
1133
|
+
|
|
1134
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1135
|
+
|
|
1136
|
+
# **v1CreateProcessedImageSetImage**
|
|
1137
|
+
> V1CreateImageSetImageResponse v1CreateProcessedImageSetImage(v1CreateProcessedImageSetImageRequest)
|
|
1138
|
+
|
|
1139
|
+
Set metadata and plate solve results for an image.
|
|
1140
|
+
|
|
1141
|
+
### Example
|
|
1142
|
+
|
|
1143
|
+
```typescript
|
|
1144
|
+
import {
|
|
1145
|
+
DefaultApi,
|
|
1146
|
+
Configuration,
|
|
1147
|
+
V1CreateProcessedImageSetImageRequest
|
|
1148
|
+
} from '@ourskyai/platform-api';
|
|
1149
|
+
|
|
1150
|
+
const configuration = new Configuration();
|
|
1151
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1152
|
+
|
|
1153
|
+
let v1CreateProcessedImageSetImageRequest: V1CreateProcessedImageSetImageRequest; //
|
|
1154
|
+
|
|
1155
|
+
const { status, data } = await apiInstance.v1CreateProcessedImageSetImage(
|
|
1156
|
+
v1CreateProcessedImageSetImageRequest
|
|
1157
|
+
);
|
|
1158
|
+
```
|
|
1159
|
+
|
|
1160
|
+
### Parameters
|
|
1161
|
+
|
|
1162
|
+
|Name | Type | Description | Notes|
|
|
1163
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1164
|
+
| **v1CreateProcessedImageSetImageRequest** | **V1CreateProcessedImageSetImageRequest**| | |
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
### Return type
|
|
1168
|
+
|
|
1169
|
+
**V1CreateImageSetImageResponse**
|
|
1170
|
+
|
|
1171
|
+
### Authorization
|
|
1172
|
+
|
|
1173
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1174
|
+
|
|
1175
|
+
### HTTP request headers
|
|
1176
|
+
|
|
1177
|
+
- **Content-Type**: application/json
|
|
1178
|
+
- **Accept**: application/json
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
### HTTP response details
|
|
1182
|
+
| Status code | Description | Response headers |
|
|
1183
|
+
|-------------|-------------|------------------|
|
|
1184
|
+
|**200** | V1CreateImageSetImageResponse | - |
|
|
1185
|
+
|
|
1186
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1187
|
+
|
|
1188
|
+
# **v1CreateTimeWindowedAsset**
|
|
1189
|
+
> V1CreateTimeWindowedAssetResponse v1CreateTimeWindowedAsset(v1CreateTimeWindowedAssetRequest)
|
|
1190
|
+
|
|
1191
|
+
Create a time windowed asset.
|
|
1192
|
+
|
|
1193
|
+
### Example
|
|
1194
|
+
|
|
1195
|
+
```typescript
|
|
1196
|
+
import {
|
|
1197
|
+
DefaultApi,
|
|
1198
|
+
Configuration,
|
|
1199
|
+
V1CreateTimeWindowedAssetRequest
|
|
1200
|
+
} from '@ourskyai/platform-api';
|
|
1201
|
+
|
|
1202
|
+
const configuration = new Configuration();
|
|
1203
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1204
|
+
|
|
1205
|
+
let v1CreateTimeWindowedAssetRequest: V1CreateTimeWindowedAssetRequest; //
|
|
1206
|
+
|
|
1207
|
+
const { status, data } = await apiInstance.v1CreateTimeWindowedAsset(
|
|
1208
|
+
v1CreateTimeWindowedAssetRequest
|
|
1209
|
+
);
|
|
1210
|
+
```
|
|
1211
|
+
|
|
1212
|
+
### Parameters
|
|
1213
|
+
|
|
1214
|
+
|Name | Type | Description | Notes|
|
|
1215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1216
|
+
| **v1CreateTimeWindowedAssetRequest** | **V1CreateTimeWindowedAssetRequest**| | |
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
### Return type
|
|
1220
|
+
|
|
1221
|
+
**V1CreateTimeWindowedAssetResponse**
|
|
1222
|
+
|
|
1223
|
+
### Authorization
|
|
1224
|
+
|
|
1225
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1226
|
+
|
|
1227
|
+
### HTTP request headers
|
|
1228
|
+
|
|
1229
|
+
- **Content-Type**: application/json
|
|
1230
|
+
- **Accept**: application/json
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
### HTTP response details
|
|
1234
|
+
| Status code | Description | Response headers |
|
|
1235
|
+
|-------------|-------------|------------------|
|
|
1236
|
+
|**200** | V1CreateTimeWindowedAssetResponse | - |
|
|
1237
|
+
|
|
1238
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1239
|
+
|
|
1240
|
+
# **v1CustomerGetSuntimes**
|
|
1241
|
+
> V1GetSuntimesResponse v1CustomerGetSuntimes()
|
|
1242
|
+
|
|
1243
|
+
Get the sunrise/sunset times for a specific node by its ID
|
|
1244
|
+
|
|
1245
|
+
### Example
|
|
1246
|
+
|
|
1247
|
+
```typescript
|
|
1248
|
+
import {
|
|
1249
|
+
DefaultApi,
|
|
1250
|
+
Configuration
|
|
1251
|
+
} from '@ourskyai/platform-api';
|
|
1252
|
+
|
|
1253
|
+
const configuration = new Configuration();
|
|
1254
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1255
|
+
|
|
1256
|
+
let nodeId: string; // (default to undefined)
|
|
1257
|
+
|
|
1258
|
+
const { status, data } = await apiInstance.v1CustomerGetSuntimes(
|
|
1259
|
+
nodeId
|
|
1260
|
+
);
|
|
1261
|
+
```
|
|
1262
|
+
|
|
1263
|
+
### Parameters
|
|
1264
|
+
|
|
1265
|
+
|Name | Type | Description | Notes|
|
|
1266
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1267
|
+
| **nodeId** | [**string**] | | defaults to undefined|
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
### Return type
|
|
1271
|
+
|
|
1272
|
+
**V1GetSuntimesResponse**
|
|
1273
|
+
|
|
1274
|
+
### Authorization
|
|
1275
|
+
|
|
1276
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1277
|
+
|
|
1278
|
+
### HTTP request headers
|
|
1279
|
+
|
|
1280
|
+
- **Content-Type**: Not defined
|
|
1281
|
+
- **Accept**: application/json
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
### HTTP response details
|
|
1285
|
+
| Status code | Description | Response headers |
|
|
1286
|
+
|-------------|-------------|------------------|
|
|
1287
|
+
|**200** | V1GetSuntimesResponse | - |
|
|
1288
|
+
|
|
1289
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1290
|
+
|
|
1291
|
+
# **v1DeleteImageSet**
|
|
1292
|
+
> EmptySuccess v1DeleteImageSet()
|
|
1293
|
+
|
|
1294
|
+
Delete an image set.
|
|
1295
|
+
|
|
1296
|
+
### Example
|
|
1297
|
+
|
|
1298
|
+
```typescript
|
|
1299
|
+
import {
|
|
1300
|
+
DefaultApi,
|
|
1301
|
+
Configuration
|
|
1302
|
+
} from '@ourskyai/platform-api';
|
|
1303
|
+
|
|
1304
|
+
const configuration = new Configuration();
|
|
1305
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1306
|
+
|
|
1307
|
+
let id: string; // (default to undefined)
|
|
1308
|
+
|
|
1309
|
+
const { status, data } = await apiInstance.v1DeleteImageSet(
|
|
1310
|
+
id
|
|
1311
|
+
);
|
|
1312
|
+
```
|
|
1313
|
+
|
|
1314
|
+
### Parameters
|
|
1315
|
+
|
|
1316
|
+
|Name | Type | Description | Notes|
|
|
1317
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1318
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
### Return type
|
|
1322
|
+
|
|
1323
|
+
**EmptySuccess**
|
|
1324
|
+
|
|
1325
|
+
### Authorization
|
|
1326
|
+
|
|
1327
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1328
|
+
|
|
1329
|
+
### HTTP request headers
|
|
1330
|
+
|
|
1331
|
+
- **Content-Type**: Not defined
|
|
1332
|
+
- **Accept**: application/json
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
### HTTP response details
|
|
1336
|
+
| Status code | Description | Response headers |
|
|
1337
|
+
|-------------|-------------|------------------|
|
|
1338
|
+
|**200** | Successful action | - |
|
|
1339
|
+
|
|
1340
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1341
|
+
|
|
1342
|
+
# **v1DeleteImageSetImage**
|
|
1343
|
+
> EmptySuccess v1DeleteImageSetImage()
|
|
1344
|
+
|
|
1345
|
+
Delete an image.
|
|
1346
|
+
|
|
1347
|
+
### Example
|
|
1348
|
+
|
|
1349
|
+
```typescript
|
|
1350
|
+
import {
|
|
1351
|
+
DefaultApi,
|
|
1352
|
+
Configuration
|
|
1353
|
+
} from '@ourskyai/platform-api';
|
|
1354
|
+
|
|
1355
|
+
const configuration = new Configuration();
|
|
1356
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1357
|
+
|
|
1358
|
+
let imageId: string; // (default to undefined)
|
|
1359
|
+
|
|
1360
|
+
const { status, data } = await apiInstance.v1DeleteImageSetImage(
|
|
1361
|
+
imageId
|
|
1362
|
+
);
|
|
1363
|
+
```
|
|
1364
|
+
|
|
1365
|
+
### Parameters
|
|
1366
|
+
|
|
1367
|
+
|Name | Type | Description | Notes|
|
|
1368
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1369
|
+
| **imageId** | [**string**] | | defaults to undefined|
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
### Return type
|
|
1373
|
+
|
|
1374
|
+
**EmptySuccess**
|
|
1375
|
+
|
|
1376
|
+
### Authorization
|
|
1377
|
+
|
|
1378
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1379
|
+
|
|
1380
|
+
### HTTP request headers
|
|
1381
|
+
|
|
1382
|
+
- **Content-Type**: Not defined
|
|
1383
|
+
- **Accept**: application/json
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
### HTTP response details
|
|
1387
|
+
| Status code | Description | Response headers |
|
|
1388
|
+
|-------------|-------------|------------------|
|
|
1389
|
+
|**200** | Successful action | - |
|
|
1390
|
+
|
|
1391
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1392
|
+
|
|
1393
|
+
# **v1DeleteNodeCommand**
|
|
1394
|
+
> EmptySuccess v1DeleteNodeCommand()
|
|
1395
|
+
|
|
1396
|
+
Delete a node command
|
|
1397
|
+
|
|
1398
|
+
### Example
|
|
1399
|
+
|
|
1400
|
+
```typescript
|
|
1401
|
+
import {
|
|
1402
|
+
DefaultApi,
|
|
1403
|
+
Configuration
|
|
1404
|
+
} from '@ourskyai/platform-api';
|
|
1405
|
+
|
|
1406
|
+
const configuration = new Configuration();
|
|
1407
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1408
|
+
|
|
1409
|
+
let id: string; // (default to undefined)
|
|
1410
|
+
|
|
1411
|
+
const { status, data } = await apiInstance.v1DeleteNodeCommand(
|
|
1412
|
+
id
|
|
1413
|
+
);
|
|
1414
|
+
```
|
|
1415
|
+
|
|
1416
|
+
### Parameters
|
|
1417
|
+
|
|
1418
|
+
|Name | Type | Description | Notes|
|
|
1419
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1420
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
### Return type
|
|
1424
|
+
|
|
1425
|
+
**EmptySuccess**
|
|
1426
|
+
|
|
1427
|
+
### Authorization
|
|
1428
|
+
|
|
1429
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1430
|
+
|
|
1431
|
+
### HTTP request headers
|
|
1432
|
+
|
|
1433
|
+
- **Content-Type**: Not defined
|
|
1434
|
+
- **Accept**: application/json
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
### HTTP response details
|
|
1438
|
+
| Status code | Description | Response headers |
|
|
1439
|
+
|-------------|-------------|------------------|
|
|
1440
|
+
|**200** | Successful action | - |
|
|
1441
|
+
|
|
1442
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1443
|
+
|
|
1444
|
+
# **v1DownloadCertificateBundle**
|
|
1445
|
+
> File v1DownloadCertificateBundle(v1RefreshCertificateRequest)
|
|
1446
|
+
|
|
1447
|
+
Issue fresh certificates for a node controller in FINISHED bootstrap status and return them as a ZIP bundle.
|
|
1448
|
+
|
|
1449
|
+
### Example
|
|
1450
|
+
|
|
1451
|
+
```typescript
|
|
1452
|
+
import {
|
|
1453
|
+
DefaultApi,
|
|
1454
|
+
Configuration,
|
|
1455
|
+
V1RefreshCertificateRequest
|
|
1456
|
+
} from '@ourskyai/platform-api';
|
|
1457
|
+
|
|
1458
|
+
const configuration = new Configuration();
|
|
1459
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1460
|
+
|
|
1461
|
+
let v1RefreshCertificateRequest: V1RefreshCertificateRequest; //
|
|
1462
|
+
|
|
1463
|
+
const { status, data } = await apiInstance.v1DownloadCertificateBundle(
|
|
1464
|
+
v1RefreshCertificateRequest
|
|
1465
|
+
);
|
|
1466
|
+
```
|
|
1467
|
+
|
|
1468
|
+
### Parameters
|
|
1469
|
+
|
|
1470
|
+
|Name | Type | Description | Notes|
|
|
1471
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1472
|
+
| **v1RefreshCertificateRequest** | **V1RefreshCertificateRequest**| | |
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
### Return type
|
|
1476
|
+
|
|
1477
|
+
**File**
|
|
1478
|
+
|
|
1479
|
+
### Authorization
|
|
1480
|
+
|
|
1481
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1482
|
+
|
|
1483
|
+
### HTTP request headers
|
|
1484
|
+
|
|
1485
|
+
- **Content-Type**: application/json
|
|
1486
|
+
- **Accept**: application/zip
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
### HTTP response details
|
|
1490
|
+
| Status code | Description | Response headers |
|
|
1491
|
+
|-------------|-------------|------------------|
|
|
1492
|
+
|**200** | Certificate bundle (zip) | - |
|
|
1493
|
+
|**400** | Node not in FINISHED status, or lineageId missing | - |
|
|
1494
|
+
|**403** | Caller does not own the requested node | - |
|
|
1495
|
+
|**404** | Node controller not found | - |
|
|
1496
|
+
|
|
1497
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1498
|
+
|
|
1499
|
+
# **v1FocuserMatch**
|
|
1500
|
+
> Array<V1Focuser> v1FocuserMatch()
|
|
1501
|
+
|
|
1502
|
+
Match focuser.
|
|
1503
|
+
|
|
1504
|
+
### Example
|
|
1505
|
+
|
|
1506
|
+
```typescript
|
|
1507
|
+
import {
|
|
1508
|
+
DefaultApi,
|
|
1509
|
+
Configuration
|
|
1510
|
+
} from '@ourskyai/platform-api';
|
|
1511
|
+
|
|
1512
|
+
const configuration = new Configuration();
|
|
1513
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1514
|
+
|
|
1515
|
+
let model: string; // (optional) (default to undefined)
|
|
1516
|
+
let travelDistanceMm: number; // (optional) (default to undefined)
|
|
1517
|
+
|
|
1518
|
+
const { status, data } = await apiInstance.v1FocuserMatch(
|
|
1519
|
+
model,
|
|
1520
|
+
travelDistanceMm
|
|
1521
|
+
);
|
|
1522
|
+
```
|
|
1523
|
+
|
|
1524
|
+
### Parameters
|
|
1525
|
+
|
|
1526
|
+
|Name | Type | Description | Notes|
|
|
1527
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1528
|
+
| **model** | [**string**] | | (optional) defaults to undefined|
|
|
1529
|
+
| **travelDistanceMm** | [**number**] | | (optional) defaults to undefined|
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
### Return type
|
|
1533
|
+
|
|
1534
|
+
**Array<V1Focuser>**
|
|
1535
|
+
|
|
1536
|
+
### Authorization
|
|
1537
|
+
|
|
1538
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1539
|
+
|
|
1540
|
+
### HTTP request headers
|
|
1541
|
+
|
|
1542
|
+
- **Content-Type**: Not defined
|
|
1543
|
+
- **Accept**: application/json
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
### HTTP response details
|
|
1547
|
+
| Status code | Description | Response headers |
|
|
1548
|
+
|-------------|-------------|------------------|
|
|
1549
|
+
|**200** | V1Focuser[] | - |
|
|
1550
|
+
|
|
1551
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1552
|
+
|
|
1553
|
+
# **v1GenerateEdgeToken**
|
|
1554
|
+
> V1GenerateEdgeTokenResponse v1GenerateEdgeToken()
|
|
1555
|
+
|
|
1556
|
+
Generates a JWT token scoped to a specific edge controller node. This token can be used to authenticate directly against the edge controller local API for local device access. The token is valid for 24 hours.
|
|
1557
|
+
|
|
1558
|
+
### Example
|
|
1559
|
+
|
|
1560
|
+
```typescript
|
|
1561
|
+
import {
|
|
1562
|
+
DefaultApi,
|
|
1563
|
+
Configuration
|
|
1564
|
+
} from '@ourskyai/platform-api';
|
|
1565
|
+
|
|
1566
|
+
const configuration = new Configuration();
|
|
1567
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1568
|
+
|
|
1569
|
+
let lineageId: string; // (optional) (default to undefined)
|
|
1570
|
+
|
|
1571
|
+
const { status, data } = await apiInstance.v1GenerateEdgeToken(
|
|
1572
|
+
lineageId
|
|
1573
|
+
);
|
|
1574
|
+
```
|
|
1575
|
+
|
|
1576
|
+
### Parameters
|
|
1577
|
+
|
|
1578
|
+
|Name | Type | Description | Notes|
|
|
1579
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1580
|
+
| **lineageId** | [**string**] | | (optional) defaults to undefined|
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
### Return type
|
|
1584
|
+
|
|
1585
|
+
**V1GenerateEdgeTokenResponse**
|
|
1586
|
+
|
|
1587
|
+
### Authorization
|
|
1588
|
+
|
|
1589
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1590
|
+
|
|
1591
|
+
### HTTP request headers
|
|
1592
|
+
|
|
1593
|
+
- **Content-Type**: Not defined
|
|
1594
|
+
- **Accept**: application/json
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
### HTTP response details
|
|
1598
|
+
| Status code | Description | Response headers |
|
|
1599
|
+
|-------------|-------------|------------------|
|
|
1600
|
+
|**200** | Successfully generated edge token | - |
|
|
1601
|
+
|
|
1602
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1603
|
+
|
|
1604
|
+
# **v1GetAllSkyImageForImage**
|
|
1605
|
+
> V1AllSkyImageForImage v1GetAllSkyImageForImage()
|
|
1606
|
+
|
|
1607
|
+
Get the closest all sky image to a given observation image\'s capture time (within 15 minutes)
|
|
1608
|
+
|
|
1609
|
+
### Example
|
|
1610
|
+
|
|
1611
|
+
```typescript
|
|
1612
|
+
import {
|
|
1613
|
+
DefaultApi,
|
|
1614
|
+
Configuration
|
|
1615
|
+
} from '@ourskyai/platform-api';
|
|
1616
|
+
|
|
1617
|
+
const configuration = new Configuration();
|
|
1618
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1619
|
+
|
|
1620
|
+
let imageId: string; // (default to undefined)
|
|
1621
|
+
|
|
1622
|
+
const { status, data } = await apiInstance.v1GetAllSkyImageForImage(
|
|
1623
|
+
imageId
|
|
1624
|
+
);
|
|
1625
|
+
```
|
|
1626
|
+
|
|
1627
|
+
### Parameters
|
|
1628
|
+
|
|
1629
|
+
|Name | Type | Description | Notes|
|
|
1630
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1631
|
+
| **imageId** | [**string**] | | defaults to undefined|
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
### Return type
|
|
1635
|
+
|
|
1636
|
+
**V1AllSkyImageForImage**
|
|
1637
|
+
|
|
1638
|
+
### Authorization
|
|
1639
|
+
|
|
1640
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1641
|
+
|
|
1642
|
+
### HTTP request headers
|
|
1643
|
+
|
|
1644
|
+
- **Content-Type**: Not defined
|
|
1645
|
+
- **Accept**: application/json
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
### HTTP response details
|
|
1649
|
+
| Status code | Description | Response headers |
|
|
1650
|
+
|-------------|-------------|------------------|
|
|
1651
|
+
|**200** | All sky image found | - |
|
|
1652
|
+
|**404** | No all sky image found within the time window | - |
|
|
1653
|
+
|
|
1654
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1655
|
+
|
|
1656
|
+
# **v1GetAllSkyPrediction**
|
|
1657
|
+
> V1AllSkyPrediction v1GetAllSkyPrediction()
|
|
1658
|
+
|
|
1659
|
+
Get an all sky prediction by ID or image id
|
|
1660
|
+
|
|
1661
|
+
### Example
|
|
1662
|
+
|
|
1663
|
+
```typescript
|
|
1664
|
+
import {
|
|
1665
|
+
DefaultApi,
|
|
1666
|
+
Configuration
|
|
1667
|
+
} from '@ourskyai/platform-api';
|
|
1668
|
+
|
|
1669
|
+
const configuration = new Configuration();
|
|
1670
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1671
|
+
|
|
1672
|
+
let imageId: string; // (optional) (default to undefined)
|
|
1673
|
+
let id: string; // (optional) (default to undefined)
|
|
1674
|
+
|
|
1675
|
+
const { status, data } = await apiInstance.v1GetAllSkyPrediction(
|
|
1676
|
+
imageId,
|
|
1677
|
+
id
|
|
1678
|
+
);
|
|
1679
|
+
```
|
|
1680
|
+
|
|
1681
|
+
### Parameters
|
|
1682
|
+
|
|
1683
|
+
|Name | Type | Description | Notes|
|
|
1684
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1685
|
+
| **imageId** | [**string**] | | (optional) defaults to undefined|
|
|
1686
|
+
| **id** | [**string**] | | (optional) defaults to undefined|
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
### Return type
|
|
1690
|
+
|
|
1691
|
+
**V1AllSkyPrediction**
|
|
1692
|
+
|
|
1693
|
+
### Authorization
|
|
1694
|
+
|
|
1695
|
+
No authorization required
|
|
1696
|
+
|
|
1697
|
+
### HTTP request headers
|
|
1698
|
+
|
|
1699
|
+
- **Content-Type**: Not defined
|
|
1700
|
+
- **Accept**: application/json
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
### HTTP response details
|
|
1704
|
+
| Status code | Description | Response headers |
|
|
1705
|
+
|-------------|-------------|------------------|
|
|
1706
|
+
|**200** | All sky prediction found | - |
|
|
1707
|
+
|
|
1708
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1709
|
+
|
|
1710
|
+
# **v1GetCameras**
|
|
1711
|
+
> Array<V1Camera> v1GetCameras()
|
|
1712
|
+
|
|
1713
|
+
Get cameras.
|
|
1714
|
+
|
|
1715
|
+
### Example
|
|
1716
|
+
|
|
1717
|
+
```typescript
|
|
1718
|
+
import {
|
|
1719
|
+
DefaultApi,
|
|
1720
|
+
Configuration
|
|
1721
|
+
} from '@ourskyai/platform-api';
|
|
1722
|
+
|
|
1723
|
+
const configuration = new Configuration();
|
|
1724
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1725
|
+
|
|
1726
|
+
const { status, data } = await apiInstance.v1GetCameras();
|
|
1727
|
+
```
|
|
1728
|
+
|
|
1729
|
+
### Parameters
|
|
1730
|
+
This endpoint does not have any parameters.
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
### Return type
|
|
1734
|
+
|
|
1735
|
+
**Array<V1Camera>**
|
|
1736
|
+
|
|
1737
|
+
### Authorization
|
|
1738
|
+
|
|
1739
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1740
|
+
|
|
1741
|
+
### HTTP request headers
|
|
1742
|
+
|
|
1743
|
+
- **Content-Type**: Not defined
|
|
1744
|
+
- **Accept**: application/json
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
### HTTP response details
|
|
1748
|
+
| Status code | Description | Response headers |
|
|
1749
|
+
|-------------|-------------|------------------|
|
|
1750
|
+
|**200** | V1Camera[] | - |
|
|
1751
|
+
|
|
1752
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1753
|
+
|
|
1754
|
+
# **v1GetImageMetadata**
|
|
1755
|
+
> V1ImageMetadata v1GetImageMetadata()
|
|
1756
|
+
|
|
1757
|
+
Get metadata about an image by image id. This includes plate solve results
|
|
1758
|
+
|
|
1759
|
+
### Example
|
|
1760
|
+
|
|
1761
|
+
```typescript
|
|
1762
|
+
import {
|
|
1763
|
+
DefaultApi,
|
|
1764
|
+
Configuration
|
|
1765
|
+
} from '@ourskyai/platform-api';
|
|
1766
|
+
|
|
1767
|
+
const configuration = new Configuration();
|
|
1768
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1769
|
+
|
|
1770
|
+
let imageId: string; // (default to undefined)
|
|
1771
|
+
|
|
1772
|
+
const { status, data } = await apiInstance.v1GetImageMetadata(
|
|
1773
|
+
imageId
|
|
1774
|
+
);
|
|
1775
|
+
```
|
|
1776
|
+
|
|
1777
|
+
### Parameters
|
|
1778
|
+
|
|
1779
|
+
|Name | Type | Description | Notes|
|
|
1780
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1781
|
+
| **imageId** | [**string**] | | defaults to undefined|
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
### Return type
|
|
1785
|
+
|
|
1786
|
+
**V1ImageMetadata**
|
|
1787
|
+
|
|
1788
|
+
### Authorization
|
|
1789
|
+
|
|
1790
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1791
|
+
|
|
1792
|
+
### HTTP request headers
|
|
1793
|
+
|
|
1794
|
+
- **Content-Type**: Not defined
|
|
1795
|
+
- **Accept**: application/json
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
### HTTP response details
|
|
1799
|
+
| Status code | Description | Response headers |
|
|
1800
|
+
|-------------|-------------|------------------|
|
|
1801
|
+
|**200** | V1ImageMetadata | - |
|
|
1802
|
+
|
|
1803
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1804
|
+
|
|
1805
|
+
# **v1GetImageSet**
|
|
1806
|
+
> V1ImageSet v1GetImageSet()
|
|
1807
|
+
|
|
1808
|
+
Get an image set.
|
|
1809
|
+
|
|
1810
|
+
### Example
|
|
1811
|
+
|
|
1812
|
+
```typescript
|
|
1813
|
+
import {
|
|
1814
|
+
DefaultApi,
|
|
1815
|
+
Configuration
|
|
1816
|
+
} from '@ourskyai/platform-api';
|
|
1817
|
+
|
|
1818
|
+
const configuration = new Configuration();
|
|
1819
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1820
|
+
|
|
1821
|
+
let id: string; // (default to undefined)
|
|
1822
|
+
|
|
1823
|
+
const { status, data } = await apiInstance.v1GetImageSet(
|
|
1824
|
+
id
|
|
1825
|
+
);
|
|
1826
|
+
```
|
|
1827
|
+
|
|
1828
|
+
### Parameters
|
|
1829
|
+
|
|
1830
|
+
|Name | Type | Description | Notes|
|
|
1831
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1832
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
### Return type
|
|
1836
|
+
|
|
1837
|
+
**V1ImageSet**
|
|
1838
|
+
|
|
1839
|
+
### Authorization
|
|
1840
|
+
|
|
1841
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1842
|
+
|
|
1843
|
+
### HTTP request headers
|
|
1844
|
+
|
|
1845
|
+
- **Content-Type**: Not defined
|
|
1846
|
+
- **Accept**: application/json
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
### HTTP response details
|
|
1850
|
+
| Status code | Description | Response headers |
|
|
1851
|
+
|-------------|-------------|------------------|
|
|
1852
|
+
|**200** | V1ImageSet | - |
|
|
1853
|
+
|
|
1854
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1855
|
+
|
|
1856
|
+
# **v1GetImageSetImage**
|
|
1857
|
+
> V1ImageSetImage v1GetImageSetImage()
|
|
1858
|
+
|
|
1859
|
+
Get an image.
|
|
1860
|
+
|
|
1861
|
+
### Example
|
|
1862
|
+
|
|
1863
|
+
```typescript
|
|
1864
|
+
import {
|
|
1865
|
+
DefaultApi,
|
|
1866
|
+
Configuration
|
|
1867
|
+
} from '@ourskyai/platform-api';
|
|
1868
|
+
|
|
1869
|
+
const configuration = new Configuration();
|
|
1870
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1871
|
+
|
|
1872
|
+
let imageId: string; // (default to undefined)
|
|
1873
|
+
|
|
1874
|
+
const { status, data } = await apiInstance.v1GetImageSetImage(
|
|
1875
|
+
imageId
|
|
1876
|
+
);
|
|
1877
|
+
```
|
|
1878
|
+
|
|
1879
|
+
### Parameters
|
|
1880
|
+
|
|
1881
|
+
|Name | Type | Description | Notes|
|
|
1882
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1883
|
+
| **imageId** | [**string**] | | defaults to undefined|
|
|
1884
|
+
|
|
1885
|
+
|
|
1886
|
+
### Return type
|
|
1887
|
+
|
|
1888
|
+
**V1ImageSetImage**
|
|
1889
|
+
|
|
1890
|
+
### Authorization
|
|
1891
|
+
|
|
1892
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1893
|
+
|
|
1894
|
+
### HTTP request headers
|
|
1895
|
+
|
|
1896
|
+
- **Content-Type**: Not defined
|
|
1897
|
+
- **Accept**: application/json
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
### HTTP response details
|
|
1901
|
+
| Status code | Description | Response headers |
|
|
1902
|
+
|-------------|-------------|------------------|
|
|
1903
|
+
|**200** | V1ImageSetImage | - |
|
|
1904
|
+
|
|
1905
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1906
|
+
|
|
1907
|
+
# **v1GetInstruction**
|
|
1908
|
+
> V1Instruction v1GetInstruction(v1GetInstructionRequest)
|
|
1909
|
+
|
|
1910
|
+
Get instruction.
|
|
1911
|
+
|
|
1912
|
+
### Example
|
|
1913
|
+
|
|
1914
|
+
```typescript
|
|
1915
|
+
import {
|
|
1916
|
+
DefaultApi,
|
|
1917
|
+
Configuration,
|
|
1918
|
+
V1GetInstructionRequest
|
|
1919
|
+
} from '@ourskyai/platform-api';
|
|
1920
|
+
|
|
1921
|
+
const configuration = new Configuration();
|
|
1922
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1923
|
+
|
|
1924
|
+
let v1GetInstructionRequest: V1GetInstructionRequest; //
|
|
1925
|
+
|
|
1926
|
+
const { status, data } = await apiInstance.v1GetInstruction(
|
|
1927
|
+
v1GetInstructionRequest
|
|
1928
|
+
);
|
|
1929
|
+
```
|
|
1930
|
+
|
|
1931
|
+
### Parameters
|
|
1932
|
+
|
|
1933
|
+
|Name | Type | Description | Notes|
|
|
1934
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1935
|
+
| **v1GetInstructionRequest** | **V1GetInstructionRequest**| | |
|
|
1936
|
+
|
|
1937
|
+
|
|
1938
|
+
### Return type
|
|
1939
|
+
|
|
1940
|
+
**V1Instruction**
|
|
1941
|
+
|
|
1942
|
+
### Authorization
|
|
1943
|
+
|
|
1944
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1945
|
+
|
|
1946
|
+
### HTTP request headers
|
|
1947
|
+
|
|
1948
|
+
- **Content-Type**: application/json
|
|
1949
|
+
- **Accept**: application/json
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
### HTTP response details
|
|
1953
|
+
| Status code | Description | Response headers |
|
|
1954
|
+
|-------------|-------------|------------------|
|
|
1955
|
+
|**200** | V1Instruction | - |
|
|
1956
|
+
|
|
1957
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1958
|
+
|
|
1959
|
+
# **v1GetLastInstructionByNodeId**
|
|
1960
|
+
> V1LastInstructionResponse v1GetLastInstructionByNodeId()
|
|
1961
|
+
|
|
1962
|
+
Get the last instruction time and type for a specific node.
|
|
1963
|
+
|
|
1964
|
+
### Example
|
|
1965
|
+
|
|
1966
|
+
```typescript
|
|
1967
|
+
import {
|
|
1968
|
+
DefaultApi,
|
|
1969
|
+
Configuration
|
|
1970
|
+
} from '@ourskyai/platform-api';
|
|
1971
|
+
|
|
1972
|
+
const configuration = new Configuration();
|
|
1973
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1974
|
+
|
|
1975
|
+
let nodeId: string; // (default to undefined)
|
|
1976
|
+
|
|
1977
|
+
const { status, data } = await apiInstance.v1GetLastInstructionByNodeId(
|
|
1978
|
+
nodeId
|
|
1979
|
+
);
|
|
1980
|
+
```
|
|
1981
|
+
|
|
1982
|
+
### Parameters
|
|
1983
|
+
|
|
1984
|
+
|Name | Type | Description | Notes|
|
|
1985
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1986
|
+
| **nodeId** | [**string**] | | defaults to undefined|
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
### Return type
|
|
1990
|
+
|
|
1991
|
+
**V1LastInstructionResponse**
|
|
1992
|
+
|
|
1993
|
+
### Authorization
|
|
1994
|
+
|
|
1995
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1996
|
+
|
|
1997
|
+
### HTTP request headers
|
|
1998
|
+
|
|
1999
|
+
- **Content-Type**: Not defined
|
|
2000
|
+
- **Accept**: application/json
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
### HTTP response details
|
|
2004
|
+
| Status code | Description | Response headers |
|
|
2005
|
+
|-------------|-------------|------------------|
|
|
2006
|
+
|**200** | V1LastInstructionResponse | - |
|
|
2007
|
+
|
|
2008
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2009
|
+
|
|
2010
|
+
# **v1GetLatestHfr**
|
|
2011
|
+
> V1LatestHfrResponse v1GetLatestHfr()
|
|
2012
|
+
|
|
2013
|
+
Get the latest HFR value for a specific node by its ID
|
|
2014
|
+
|
|
2015
|
+
### Example
|
|
2016
|
+
|
|
2017
|
+
```typescript
|
|
2018
|
+
import {
|
|
2019
|
+
DefaultApi,
|
|
2020
|
+
Configuration
|
|
2021
|
+
} from '@ourskyai/platform-api';
|
|
2022
|
+
|
|
2023
|
+
const configuration = new Configuration();
|
|
2024
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2025
|
+
|
|
2026
|
+
let nodeId: string; // (default to undefined)
|
|
2027
|
+
|
|
2028
|
+
const { status, data } = await apiInstance.v1GetLatestHfr(
|
|
2029
|
+
nodeId
|
|
2030
|
+
);
|
|
2031
|
+
```
|
|
2032
|
+
|
|
2033
|
+
### Parameters
|
|
2034
|
+
|
|
2035
|
+
|Name | Type | Description | Notes|
|
|
2036
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2037
|
+
| **nodeId** | [**string**] | | defaults to undefined|
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
### Return type
|
|
2041
|
+
|
|
2042
|
+
**V1LatestHfrResponse**
|
|
2043
|
+
|
|
2044
|
+
### Authorization
|
|
2045
|
+
|
|
2046
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2047
|
+
|
|
2048
|
+
### HTTP request headers
|
|
2049
|
+
|
|
2050
|
+
- **Content-Type**: Not defined
|
|
2051
|
+
- **Accept**: application/json
|
|
2052
|
+
|
|
2053
|
+
|
|
2054
|
+
### HTTP response details
|
|
2055
|
+
| Status code | Description | Response headers |
|
|
2056
|
+
|-------------|-------------|------------------|
|
|
2057
|
+
|**200** | V1LatestHfrResponse | - |
|
|
2058
|
+
|
|
2059
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2060
|
+
|
|
2061
|
+
# **v1GetLatestModel**
|
|
2062
|
+
> V1MLModel v1GetLatestModel()
|
|
2063
|
+
|
|
2064
|
+
GetLatestModel
|
|
2065
|
+
|
|
2066
|
+
### Example
|
|
2067
|
+
|
|
2068
|
+
```typescript
|
|
2069
|
+
import {
|
|
2070
|
+
DefaultApi,
|
|
2071
|
+
Configuration
|
|
2072
|
+
} from '@ourskyai/platform-api';
|
|
2073
|
+
|
|
2074
|
+
const configuration = new Configuration();
|
|
2075
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2076
|
+
|
|
2077
|
+
let modelType: ModelType; // (default to undefined)
|
|
2078
|
+
let lineageId: string; // (default to undefined)
|
|
2079
|
+
|
|
2080
|
+
const { status, data } = await apiInstance.v1GetLatestModel(
|
|
2081
|
+
modelType,
|
|
2082
|
+
lineageId
|
|
2083
|
+
);
|
|
2084
|
+
```
|
|
2085
|
+
|
|
2086
|
+
### Parameters
|
|
2087
|
+
|
|
2088
|
+
|Name | Type | Description | Notes|
|
|
2089
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2090
|
+
| **modelType** | **ModelType** | | defaults to undefined|
|
|
2091
|
+
| **lineageId** | [**string**] | | defaults to undefined|
|
|
2092
|
+
|
|
2093
|
+
|
|
2094
|
+
### Return type
|
|
2095
|
+
|
|
2096
|
+
**V1MLModel**
|
|
2097
|
+
|
|
2098
|
+
### Authorization
|
|
2099
|
+
|
|
2100
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2101
|
+
|
|
2102
|
+
### HTTP request headers
|
|
2103
|
+
|
|
2104
|
+
- **Content-Type**: Not defined
|
|
2105
|
+
- **Accept**: application/json
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
### HTTP response details
|
|
2109
|
+
| Status code | Description | Response headers |
|
|
2110
|
+
|-------------|-------------|------------------|
|
|
2111
|
+
|**200** | The latest model of the given type | - |
|
|
2112
|
+
|
|
2113
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2114
|
+
|
|
2115
|
+
# **v1GetMergedNodeConfigBody**
|
|
2116
|
+
> V1NodeConfigBody v1GetMergedNodeConfigBody()
|
|
2117
|
+
|
|
2118
|
+
Get merged node config body
|
|
2119
|
+
|
|
2120
|
+
### Example
|
|
2121
|
+
|
|
2122
|
+
```typescript
|
|
2123
|
+
import {
|
|
2124
|
+
DefaultApi,
|
|
2125
|
+
Configuration
|
|
2126
|
+
} from '@ourskyai/platform-api';
|
|
2127
|
+
|
|
2128
|
+
const configuration = new Configuration();
|
|
2129
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2130
|
+
|
|
2131
|
+
let nodeId: string; // (default to undefined)
|
|
2132
|
+
|
|
2133
|
+
const { status, data } = await apiInstance.v1GetMergedNodeConfigBody(
|
|
2134
|
+
nodeId
|
|
2135
|
+
);
|
|
2136
|
+
```
|
|
2137
|
+
|
|
2138
|
+
### Parameters
|
|
2139
|
+
|
|
2140
|
+
|Name | Type | Description | Notes|
|
|
2141
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2142
|
+
| **nodeId** | [**string**] | | defaults to undefined|
|
|
2143
|
+
|
|
2144
|
+
|
|
2145
|
+
### Return type
|
|
2146
|
+
|
|
2147
|
+
**V1NodeConfigBody**
|
|
2148
|
+
|
|
2149
|
+
### Authorization
|
|
2150
|
+
|
|
2151
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2152
|
+
|
|
2153
|
+
### HTTP request headers
|
|
2154
|
+
|
|
2155
|
+
- **Content-Type**: Not defined
|
|
2156
|
+
- **Accept**: application/json
|
|
2157
|
+
|
|
2158
|
+
|
|
2159
|
+
### HTTP response details
|
|
2160
|
+
| Status code | Description | Response headers |
|
|
2161
|
+
|-------------|-------------|------------------|
|
|
2162
|
+
|**200** | V1NodeConfigBody | - |
|
|
2163
|
+
|
|
2164
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2165
|
+
|
|
2166
|
+
# **v1GetNode**
|
|
2167
|
+
> V1Node v1GetNode()
|
|
2168
|
+
|
|
2169
|
+
Get node by lineage id or node id.
|
|
2170
|
+
|
|
2171
|
+
### Example
|
|
2172
|
+
|
|
2173
|
+
```typescript
|
|
2174
|
+
import {
|
|
2175
|
+
DefaultApi,
|
|
2176
|
+
Configuration
|
|
2177
|
+
} from '@ourskyai/platform-api';
|
|
2178
|
+
|
|
2179
|
+
const configuration = new Configuration();
|
|
2180
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2181
|
+
|
|
2182
|
+
let lineageId: string; // (optional) (default to undefined)
|
|
2183
|
+
let nodeId: string; // (optional) (default to undefined)
|
|
2184
|
+
|
|
2185
|
+
const { status, data } = await apiInstance.v1GetNode(
|
|
2186
|
+
lineageId,
|
|
2187
|
+
nodeId
|
|
2188
|
+
);
|
|
2189
|
+
```
|
|
2190
|
+
|
|
2191
|
+
### Parameters
|
|
2192
|
+
|
|
2193
|
+
|Name | Type | Description | Notes|
|
|
2194
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2195
|
+
| **lineageId** | [**string**] | | (optional) defaults to undefined|
|
|
2196
|
+
| **nodeId** | [**string**] | | (optional) defaults to undefined|
|
|
2197
|
+
|
|
2198
|
+
|
|
2199
|
+
### Return type
|
|
2200
|
+
|
|
2201
|
+
**V1Node**
|
|
2202
|
+
|
|
2203
|
+
### Authorization
|
|
2204
|
+
|
|
2205
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2206
|
+
|
|
2207
|
+
### HTTP request headers
|
|
2208
|
+
|
|
2209
|
+
- **Content-Type**: Not defined
|
|
2210
|
+
- **Accept**: application/json
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
### HTTP response details
|
|
2214
|
+
| Status code | Description | Response headers |
|
|
2215
|
+
|-------------|-------------|------------------|
|
|
2216
|
+
|**200** | V1Node | - |
|
|
2217
|
+
|
|
2218
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2219
|
+
|
|
2220
|
+
# **v1GetNodeCommands**
|
|
2221
|
+
> V1GetNodeCommandsResponse v1GetNodeCommands()
|
|
2222
|
+
|
|
2223
|
+
Get node commands
|
|
2224
|
+
|
|
2225
|
+
### Example
|
|
2226
|
+
|
|
2227
|
+
```typescript
|
|
2228
|
+
import {
|
|
2229
|
+
DefaultApi,
|
|
2230
|
+
Configuration
|
|
2231
|
+
} from '@ourskyai/platform-api';
|
|
2232
|
+
|
|
2233
|
+
const configuration = new Configuration();
|
|
2234
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2235
|
+
|
|
2236
|
+
let nodeId: string; // (default to undefined)
|
|
2237
|
+
let executableAt: string; // (default to undefined)
|
|
2238
|
+
|
|
2239
|
+
const { status, data } = await apiInstance.v1GetNodeCommands(
|
|
2240
|
+
nodeId,
|
|
2241
|
+
executableAt
|
|
2242
|
+
);
|
|
2243
|
+
```
|
|
2244
|
+
|
|
2245
|
+
### Parameters
|
|
2246
|
+
|
|
2247
|
+
|Name | Type | Description | Notes|
|
|
2248
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2249
|
+
| **nodeId** | [**string**] | | defaults to undefined|
|
|
2250
|
+
| **executableAt** | [**string**] | | defaults to undefined|
|
|
2251
|
+
|
|
2252
|
+
|
|
2253
|
+
### Return type
|
|
2254
|
+
|
|
2255
|
+
**V1GetNodeCommandsResponse**
|
|
2256
|
+
|
|
2257
|
+
### Authorization
|
|
2258
|
+
|
|
2259
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2260
|
+
|
|
2261
|
+
### HTTP request headers
|
|
2262
|
+
|
|
2263
|
+
- **Content-Type**: Not defined
|
|
2264
|
+
- **Accept**: application/json
|
|
2265
|
+
|
|
2266
|
+
|
|
2267
|
+
### HTTP response details
|
|
2268
|
+
| Status code | Description | Response headers |
|
|
2269
|
+
|-------------|-------------|------------------|
|
|
2270
|
+
|**200** | V1GetNodeCommandsResponse | - |
|
|
2271
|
+
|
|
2272
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2273
|
+
|
|
2274
|
+
# **v1GetNodeDiagnosticTasks**
|
|
2275
|
+
> Array<V1NodeDiagnosticType> v1GetNodeDiagnosticTasks()
|
|
2276
|
+
|
|
2277
|
+
Get node diagnostic tasks.
|
|
2278
|
+
|
|
2279
|
+
### Example
|
|
2280
|
+
|
|
2281
|
+
```typescript
|
|
2282
|
+
import {
|
|
2283
|
+
DefaultApi,
|
|
2284
|
+
Configuration
|
|
2285
|
+
} from '@ourskyai/platform-api';
|
|
2286
|
+
|
|
2287
|
+
const configuration = new Configuration();
|
|
2288
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2289
|
+
|
|
2290
|
+
let nodeId: string; // (default to undefined)
|
|
2291
|
+
let supportedDiagnostics: Array<V1NodeDiagnosticType>; // (optional) (default to undefined)
|
|
2292
|
+
|
|
2293
|
+
const { status, data } = await apiInstance.v1GetNodeDiagnosticTasks(
|
|
2294
|
+
nodeId,
|
|
2295
|
+
supportedDiagnostics
|
|
2296
|
+
);
|
|
2297
|
+
```
|
|
2298
|
+
|
|
2299
|
+
### Parameters
|
|
2300
|
+
|
|
2301
|
+
|Name | Type | Description | Notes|
|
|
2302
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2303
|
+
| **nodeId** | [**string**] | | defaults to undefined|
|
|
2304
|
+
| **supportedDiagnostics** | **Array<V1NodeDiagnosticType>** | | (optional) defaults to undefined|
|
|
2305
|
+
|
|
2306
|
+
|
|
2307
|
+
### Return type
|
|
2308
|
+
|
|
2309
|
+
**Array<V1NodeDiagnosticType>**
|
|
2310
|
+
|
|
2311
|
+
### Authorization
|
|
2312
|
+
|
|
2313
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2314
|
+
|
|
2315
|
+
### HTTP request headers
|
|
2316
|
+
|
|
2317
|
+
- **Content-Type**: Not defined
|
|
2318
|
+
- **Accept**: application/json
|
|
2319
|
+
|
|
2320
|
+
|
|
2321
|
+
### HTTP response details
|
|
2322
|
+
| Status code | Description | Response headers |
|
|
2323
|
+
|-------------|-------------|------------------|
|
|
2324
|
+
|**200** | V1NodeDiagnosticType[] | - |
|
|
2325
|
+
|
|
2326
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2327
|
+
|
|
2328
|
+
# **v1GetNodeEventsApexChartsTimeline**
|
|
2329
|
+
> V1ApexChartsTimeline v1GetNodeEventsApexChartsTimeline()
|
|
2330
|
+
|
|
2331
|
+
Get node events Apex Charts timeline
|
|
2332
|
+
|
|
2333
|
+
### Example
|
|
2334
|
+
|
|
2335
|
+
```typescript
|
|
2336
|
+
import {
|
|
2337
|
+
DefaultApi,
|
|
2338
|
+
Configuration
|
|
2339
|
+
} from '@ourskyai/platform-api';
|
|
2340
|
+
|
|
2341
|
+
const configuration = new Configuration();
|
|
2342
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2343
|
+
|
|
2344
|
+
let startTime: string; // (default to undefined)
|
|
2345
|
+
let endTime: string; // (default to undefined)
|
|
2346
|
+
let nodeId: string; // (optional) (default to undefined)
|
|
2347
|
+
let lineageId: string; // (optional) (default to undefined)
|
|
2348
|
+
|
|
2349
|
+
const { status, data } = await apiInstance.v1GetNodeEventsApexChartsTimeline(
|
|
2350
|
+
startTime,
|
|
2351
|
+
endTime,
|
|
2352
|
+
nodeId,
|
|
2353
|
+
lineageId
|
|
2354
|
+
);
|
|
2355
|
+
```
|
|
2356
|
+
|
|
2357
|
+
### Parameters
|
|
2358
|
+
|
|
2359
|
+
|Name | Type | Description | Notes|
|
|
2360
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2361
|
+
| **startTime** | [**string**] | | defaults to undefined|
|
|
2362
|
+
| **endTime** | [**string**] | | defaults to undefined|
|
|
2363
|
+
| **nodeId** | [**string**] | | (optional) defaults to undefined|
|
|
2364
|
+
| **lineageId** | [**string**] | | (optional) defaults to undefined|
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
### Return type
|
|
2368
|
+
|
|
2369
|
+
**V1ApexChartsTimeline**
|
|
2370
|
+
|
|
2371
|
+
### Authorization
|
|
2372
|
+
|
|
2373
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2374
|
+
|
|
2375
|
+
### HTTP request headers
|
|
2376
|
+
|
|
2377
|
+
- **Content-Type**: Not defined
|
|
2378
|
+
- **Accept**: application/json
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
### HTTP response details
|
|
2382
|
+
| Status code | Description | Response headers |
|
|
2383
|
+
|-------------|-------------|------------------|
|
|
2384
|
+
|**200** | V1ApexChartsTimeline | - |
|
|
2385
|
+
|
|
2386
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2387
|
+
|
|
2388
|
+
# **v1GetNodeFlare**
|
|
2389
|
+
> V1NodeFlare v1GetNodeFlare()
|
|
2390
|
+
|
|
2391
|
+
Get a node flare by id.
|
|
2392
|
+
|
|
2393
|
+
### Example
|
|
2394
|
+
|
|
2395
|
+
```typescript
|
|
2396
|
+
import {
|
|
2397
|
+
DefaultApi,
|
|
2398
|
+
Configuration
|
|
2399
|
+
} from '@ourskyai/platform-api';
|
|
2400
|
+
|
|
2401
|
+
const configuration = new Configuration();
|
|
2402
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2403
|
+
|
|
2404
|
+
let id: string; // (default to undefined)
|
|
2405
|
+
|
|
2406
|
+
const { status, data } = await apiInstance.v1GetNodeFlare(
|
|
2407
|
+
id
|
|
2408
|
+
);
|
|
2409
|
+
```
|
|
2410
|
+
|
|
2411
|
+
### Parameters
|
|
2412
|
+
|
|
2413
|
+
|Name | Type | Description | Notes|
|
|
2414
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2415
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
### Return type
|
|
2419
|
+
|
|
2420
|
+
**V1NodeFlare**
|
|
2421
|
+
|
|
2422
|
+
### Authorization
|
|
2423
|
+
|
|
2424
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2425
|
+
|
|
2426
|
+
### HTTP request headers
|
|
2427
|
+
|
|
2428
|
+
- **Content-Type**: Not defined
|
|
2429
|
+
- **Accept**: application/json
|
|
2430
|
+
|
|
2431
|
+
|
|
2432
|
+
### HTTP response details
|
|
2433
|
+
| Status code | Description | Response headers |
|
|
2434
|
+
|-------------|-------------|------------------|
|
|
2435
|
+
|**200** | V1NodeFlare | - |
|
|
2436
|
+
|
|
2437
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2438
|
+
|
|
2439
|
+
# **v1GetNodes**
|
|
2440
|
+
> V1GetNodes v1GetNodes()
|
|
2441
|
+
|
|
2442
|
+
Get nodes.
|
|
2443
|
+
|
|
2444
|
+
### Example
|
|
2445
|
+
|
|
2446
|
+
```typescript
|
|
2447
|
+
import {
|
|
2448
|
+
DefaultApi,
|
|
2449
|
+
Configuration
|
|
2450
|
+
} from '@ourskyai/platform-api';
|
|
2451
|
+
|
|
2452
|
+
const configuration = new Configuration();
|
|
2453
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2454
|
+
|
|
2455
|
+
const { status, data } = await apiInstance.v1GetNodes();
|
|
2456
|
+
```
|
|
2457
|
+
|
|
2458
|
+
### Parameters
|
|
2459
|
+
This endpoint does not have any parameters.
|
|
2460
|
+
|
|
2461
|
+
|
|
2462
|
+
### Return type
|
|
2463
|
+
|
|
2464
|
+
**V1GetNodes**
|
|
2465
|
+
|
|
2466
|
+
### Authorization
|
|
2467
|
+
|
|
2468
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2469
|
+
|
|
2470
|
+
### HTTP request headers
|
|
2471
|
+
|
|
2472
|
+
- **Content-Type**: Not defined
|
|
2473
|
+
- **Accept**: application/json
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
### HTTP response details
|
|
2477
|
+
| Status code | Description | Response headers |
|
|
2478
|
+
|-------------|-------------|------------------|
|
|
2479
|
+
|**200** | V1GetNodes | - |
|
|
2480
|
+
|
|
2481
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2482
|
+
|
|
2483
|
+
# **v1GetOTAEncryption**
|
|
2484
|
+
> V1OTAEncryptionResult v1GetOTAEncryption()
|
|
2485
|
+
|
|
2486
|
+
Get OTA encryption result
|
|
2487
|
+
|
|
2488
|
+
### Example
|
|
2489
|
+
|
|
2490
|
+
```typescript
|
|
2491
|
+
import {
|
|
2492
|
+
DefaultApi,
|
|
2493
|
+
Configuration
|
|
2494
|
+
} from '@ourskyai/platform-api';
|
|
2495
|
+
|
|
2496
|
+
const configuration = new Configuration();
|
|
2497
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2498
|
+
|
|
2499
|
+
let id: string; // (default to undefined)
|
|
2500
|
+
|
|
2501
|
+
const { status, data } = await apiInstance.v1GetOTAEncryption(
|
|
2502
|
+
id
|
|
2503
|
+
);
|
|
2504
|
+
```
|
|
2505
|
+
|
|
2506
|
+
### Parameters
|
|
2507
|
+
|
|
2508
|
+
|Name | Type | Description | Notes|
|
|
2509
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2510
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
2511
|
+
|
|
2512
|
+
|
|
2513
|
+
### Return type
|
|
2514
|
+
|
|
2515
|
+
**V1OTAEncryptionResult**
|
|
2516
|
+
|
|
2517
|
+
### Authorization
|
|
2518
|
+
|
|
2519
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2520
|
+
|
|
2521
|
+
### HTTP request headers
|
|
2522
|
+
|
|
2523
|
+
- **Content-Type**: Not defined
|
|
2524
|
+
- **Accept**: application/json
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
### HTTP response details
|
|
2528
|
+
| Status code | Description | Response headers |
|
|
2529
|
+
|-------------|-------------|------------------|
|
|
2530
|
+
|**200** | V1OTAEncryption | - |
|
|
2531
|
+
|
|
2532
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2533
|
+
|
|
2534
|
+
# **v1GetOpticalTube**
|
|
2535
|
+
> V1OpticalTube v1GetOpticalTube()
|
|
2536
|
+
|
|
2537
|
+
Get an optical tube.
|
|
2538
|
+
|
|
2539
|
+
### Example
|
|
2540
|
+
|
|
2541
|
+
```typescript
|
|
2542
|
+
import {
|
|
2543
|
+
DefaultApi,
|
|
2544
|
+
Configuration
|
|
2545
|
+
} from '@ourskyai/platform-api';
|
|
2546
|
+
|
|
2547
|
+
const configuration = new Configuration();
|
|
2548
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2549
|
+
|
|
2550
|
+
let id: string; // (default to undefined)
|
|
2551
|
+
|
|
2552
|
+
const { status, data } = await apiInstance.v1GetOpticalTube(
|
|
2553
|
+
id
|
|
2554
|
+
);
|
|
2555
|
+
```
|
|
2556
|
+
|
|
2557
|
+
### Parameters
|
|
2558
|
+
|
|
2559
|
+
|Name | Type | Description | Notes|
|
|
2560
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2561
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
2562
|
+
|
|
2563
|
+
|
|
2564
|
+
### Return type
|
|
2565
|
+
|
|
2566
|
+
**V1OpticalTube**
|
|
2567
|
+
|
|
2568
|
+
### Authorization
|
|
2569
|
+
|
|
2570
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2571
|
+
|
|
2572
|
+
### HTTP request headers
|
|
2573
|
+
|
|
2574
|
+
- **Content-Type**: Not defined
|
|
2575
|
+
- **Accept**: application/json
|
|
2576
|
+
|
|
2577
|
+
|
|
2578
|
+
### HTTP response details
|
|
2579
|
+
| Status code | Description | Response headers |
|
|
2580
|
+
|-------------|-------------|------------------|
|
|
2581
|
+
|**200** | V1OpticalTube | - |
|
|
2582
|
+
|
|
2583
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2584
|
+
|
|
2585
|
+
# **v1GetOrCreateCamera**
|
|
2586
|
+
> V1Camera v1GetOrCreateCamera(v1GetOrCreateCameraRequest)
|
|
2587
|
+
|
|
2588
|
+
Get or create camera.
|
|
2589
|
+
|
|
2590
|
+
### Example
|
|
2591
|
+
|
|
2592
|
+
```typescript
|
|
2593
|
+
import {
|
|
2594
|
+
DefaultApi,
|
|
2595
|
+
Configuration,
|
|
2596
|
+
V1GetOrCreateCameraRequest
|
|
2597
|
+
} from '@ourskyai/platform-api';
|
|
2598
|
+
|
|
2599
|
+
const configuration = new Configuration();
|
|
2600
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2601
|
+
|
|
2602
|
+
let v1GetOrCreateCameraRequest: V1GetOrCreateCameraRequest; //
|
|
2603
|
+
|
|
2604
|
+
const { status, data } = await apiInstance.v1GetOrCreateCamera(
|
|
2605
|
+
v1GetOrCreateCameraRequest
|
|
2606
|
+
);
|
|
2607
|
+
```
|
|
2608
|
+
|
|
2609
|
+
### Parameters
|
|
2610
|
+
|
|
2611
|
+
|Name | Type | Description | Notes|
|
|
2612
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2613
|
+
| **v1GetOrCreateCameraRequest** | **V1GetOrCreateCameraRequest**| | |
|
|
2614
|
+
|
|
2615
|
+
|
|
2616
|
+
### Return type
|
|
2617
|
+
|
|
2618
|
+
**V1Camera**
|
|
2619
|
+
|
|
2620
|
+
### Authorization
|
|
2621
|
+
|
|
2622
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2623
|
+
|
|
2624
|
+
### HTTP request headers
|
|
2625
|
+
|
|
2626
|
+
- **Content-Type**: application/json
|
|
2627
|
+
- **Accept**: application/json
|
|
2628
|
+
|
|
2629
|
+
|
|
2630
|
+
### HTTP response details
|
|
2631
|
+
| Status code | Description | Response headers |
|
|
2632
|
+
|-------------|-------------|------------------|
|
|
2633
|
+
|**200** | V1Camera | - |
|
|
2634
|
+
|
|
2635
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2636
|
+
|
|
2637
|
+
# **v1GetOrCreateFocuser**
|
|
2638
|
+
> V1Focuser v1GetOrCreateFocuser(v1GetOrCreateFocuserRequest)
|
|
2639
|
+
|
|
2640
|
+
Get or create focuser.
|
|
2641
|
+
|
|
2642
|
+
### Example
|
|
2643
|
+
|
|
2644
|
+
```typescript
|
|
2645
|
+
import {
|
|
2646
|
+
DefaultApi,
|
|
2647
|
+
Configuration,
|
|
2648
|
+
V1GetOrCreateFocuserRequest
|
|
2649
|
+
} from '@ourskyai/platform-api';
|
|
2650
|
+
|
|
2651
|
+
const configuration = new Configuration();
|
|
2652
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2653
|
+
|
|
2654
|
+
let v1GetOrCreateFocuserRequest: V1GetOrCreateFocuserRequest; //
|
|
2655
|
+
|
|
2656
|
+
const { status, data } = await apiInstance.v1GetOrCreateFocuser(
|
|
2657
|
+
v1GetOrCreateFocuserRequest
|
|
2658
|
+
);
|
|
2659
|
+
```
|
|
2660
|
+
|
|
2661
|
+
### Parameters
|
|
2662
|
+
|
|
2663
|
+
|Name | Type | Description | Notes|
|
|
2664
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2665
|
+
| **v1GetOrCreateFocuserRequest** | **V1GetOrCreateFocuserRequest**| | |
|
|
2666
|
+
|
|
2667
|
+
|
|
2668
|
+
### Return type
|
|
2669
|
+
|
|
2670
|
+
**V1Focuser**
|
|
2671
|
+
|
|
2672
|
+
### Authorization
|
|
2673
|
+
|
|
2674
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2675
|
+
|
|
2676
|
+
### HTTP request headers
|
|
2677
|
+
|
|
2678
|
+
- **Content-Type**: application/json
|
|
2679
|
+
- **Accept**: application/json
|
|
2680
|
+
|
|
2681
|
+
|
|
2682
|
+
### HTTP response details
|
|
2683
|
+
| Status code | Description | Response headers |
|
|
2684
|
+
|-------------|-------------|------------------|
|
|
2685
|
+
|**200** | V1Focuser | - |
|
|
2686
|
+
|
|
2687
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2688
|
+
|
|
2689
|
+
# **v1GetOrCreateMount**
|
|
2690
|
+
> V1Mount v1GetOrCreateMount(v1GetOrCreateMountRequest)
|
|
2691
|
+
|
|
2692
|
+
Get or create mount.
|
|
2693
|
+
|
|
2694
|
+
### Example
|
|
2695
|
+
|
|
2696
|
+
```typescript
|
|
2697
|
+
import {
|
|
2698
|
+
DefaultApi,
|
|
2699
|
+
Configuration,
|
|
2700
|
+
V1GetOrCreateMountRequest
|
|
2701
|
+
} from '@ourskyai/platform-api';
|
|
2702
|
+
|
|
2703
|
+
const configuration = new Configuration();
|
|
2704
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2705
|
+
|
|
2706
|
+
let v1GetOrCreateMountRequest: V1GetOrCreateMountRequest; //
|
|
2707
|
+
|
|
2708
|
+
const { status, data } = await apiInstance.v1GetOrCreateMount(
|
|
2709
|
+
v1GetOrCreateMountRequest
|
|
2710
|
+
);
|
|
2711
|
+
```
|
|
2712
|
+
|
|
2713
|
+
### Parameters
|
|
2714
|
+
|
|
2715
|
+
|Name | Type | Description | Notes|
|
|
2716
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2717
|
+
| **v1GetOrCreateMountRequest** | **V1GetOrCreateMountRequest**| | |
|
|
2718
|
+
|
|
2719
|
+
|
|
2720
|
+
### Return type
|
|
2721
|
+
|
|
2722
|
+
**V1Mount**
|
|
2723
|
+
|
|
2724
|
+
### Authorization
|
|
2725
|
+
|
|
2726
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2727
|
+
|
|
2728
|
+
### HTTP request headers
|
|
2729
|
+
|
|
2730
|
+
- **Content-Type**: application/json
|
|
2731
|
+
- **Accept**: application/json
|
|
2732
|
+
|
|
2733
|
+
|
|
2734
|
+
### HTTP response details
|
|
2735
|
+
| Status code | Description | Response headers |
|
|
2736
|
+
|-------------|-------------|------------------|
|
|
2737
|
+
|**200** | V1Mount | - |
|
|
2738
|
+
|
|
2739
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2740
|
+
|
|
2741
|
+
# **v1GetPlateSolveCatalogDiff**
|
|
2742
|
+
> Array<V1PlateSolveCatalogFileDownload> v1GetPlateSolveCatalogDiff(v1GetPlateSolveCatalogDiffRequest)
|
|
2743
|
+
|
|
2744
|
+
Get a diff of plate solve catalog files.
|
|
2745
|
+
|
|
2746
|
+
### Example
|
|
2747
|
+
|
|
2748
|
+
```typescript
|
|
2749
|
+
import {
|
|
2750
|
+
DefaultApi,
|
|
2751
|
+
Configuration,
|
|
2752
|
+
V1GetPlateSolveCatalogDiffRequest
|
|
2753
|
+
} from '@ourskyai/platform-api';
|
|
2754
|
+
|
|
2755
|
+
const configuration = new Configuration();
|
|
2756
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2757
|
+
|
|
2758
|
+
let v1GetPlateSolveCatalogDiffRequest: V1GetPlateSolveCatalogDiffRequest; //
|
|
2759
|
+
|
|
2760
|
+
const { status, data } = await apiInstance.v1GetPlateSolveCatalogDiff(
|
|
2761
|
+
v1GetPlateSolveCatalogDiffRequest
|
|
2762
|
+
);
|
|
2763
|
+
```
|
|
2764
|
+
|
|
2765
|
+
### Parameters
|
|
2766
|
+
|
|
2767
|
+
|Name | Type | Description | Notes|
|
|
2768
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2769
|
+
| **v1GetPlateSolveCatalogDiffRequest** | **V1GetPlateSolveCatalogDiffRequest**| | |
|
|
2770
|
+
|
|
2771
|
+
|
|
2772
|
+
### Return type
|
|
2773
|
+
|
|
2774
|
+
**Array<V1PlateSolveCatalogFileDownload>**
|
|
2775
|
+
|
|
2776
|
+
### Authorization
|
|
2777
|
+
|
|
2778
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2779
|
+
|
|
2780
|
+
### HTTP request headers
|
|
2781
|
+
|
|
2782
|
+
- **Content-Type**: application/json
|
|
2783
|
+
- **Accept**: application/json
|
|
2784
|
+
|
|
2785
|
+
|
|
2786
|
+
### HTTP response details
|
|
2787
|
+
| Status code | Description | Response headers |
|
|
2788
|
+
|-------------|-------------|------------------|
|
|
2789
|
+
|**200** | Diff of existing files and source of truth. | - |
|
|
2790
|
+
|
|
2791
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2792
|
+
|
|
2793
|
+
# **v1GetSkyAtlasSatellites**
|
|
2794
|
+
> File v1GetSkyAtlasSatellites()
|
|
2795
|
+
|
|
2796
|
+
Get satellites for skyAtlas. returns jsonl
|
|
2797
|
+
|
|
2798
|
+
### Example
|
|
2799
|
+
|
|
2800
|
+
```typescript
|
|
2801
|
+
import {
|
|
2802
|
+
DefaultApi,
|
|
2803
|
+
Configuration
|
|
2804
|
+
} from '@ourskyai/platform-api';
|
|
2805
|
+
|
|
2806
|
+
const configuration = new Configuration();
|
|
2807
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2808
|
+
|
|
2809
|
+
const { status, data } = await apiInstance.v1GetSkyAtlasSatellites();
|
|
2810
|
+
```
|
|
2811
|
+
|
|
2812
|
+
### Parameters
|
|
2813
|
+
This endpoint does not have any parameters.
|
|
2814
|
+
|
|
2815
|
+
|
|
2816
|
+
### Return type
|
|
2817
|
+
|
|
2818
|
+
**File**
|
|
2819
|
+
|
|
2820
|
+
### Authorization
|
|
2821
|
+
|
|
2822
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2823
|
+
|
|
2824
|
+
### HTTP request headers
|
|
2825
|
+
|
|
2826
|
+
- **Content-Type**: Not defined
|
|
2827
|
+
- **Accept**: application/octet-stream
|
|
2828
|
+
|
|
2829
|
+
|
|
2830
|
+
### HTTP response details
|
|
2831
|
+
| Status code | Description | Response headers |
|
|
2832
|
+
|-------------|-------------|------------------|
|
|
2833
|
+
|**200** | JSONL stream of satellite entries | - |
|
|
2834
|
+
|**500** | Server error | - |
|
|
2835
|
+
|
|
2836
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2837
|
+
|
|
2838
|
+
# **v1GetTargetQCOMOTASoftwareReleaseForNode**
|
|
2839
|
+
> V1SoftwareRelease v1GetTargetQCOMOTASoftwareReleaseForNode()
|
|
2840
|
+
|
|
2841
|
+
Get the target QCOM OTA software release for a node
|
|
2842
|
+
|
|
2843
|
+
### Example
|
|
2844
|
+
|
|
2845
|
+
```typescript
|
|
2846
|
+
import {
|
|
2847
|
+
DefaultApi,
|
|
2848
|
+
Configuration
|
|
2849
|
+
} from '@ourskyai/platform-api';
|
|
2850
|
+
|
|
2851
|
+
const configuration = new Configuration();
|
|
2852
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2853
|
+
|
|
2854
|
+
const { status, data } = await apiInstance.v1GetTargetQCOMOTASoftwareReleaseForNode();
|
|
2855
|
+
```
|
|
2856
|
+
|
|
2857
|
+
### Parameters
|
|
2858
|
+
This endpoint does not have any parameters.
|
|
2859
|
+
|
|
2860
|
+
|
|
2861
|
+
### Return type
|
|
2862
|
+
|
|
2863
|
+
**V1SoftwareRelease**
|
|
2864
|
+
|
|
2865
|
+
### Authorization
|
|
2866
|
+
|
|
2867
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2868
|
+
|
|
2869
|
+
### HTTP request headers
|
|
2870
|
+
|
|
2871
|
+
- **Content-Type**: Not defined
|
|
2872
|
+
- **Accept**: application/json
|
|
2873
|
+
|
|
2874
|
+
|
|
2875
|
+
### HTTP response details
|
|
2876
|
+
| Status code | Description | Response headers |
|
|
2877
|
+
|-------------|-------------|------------------|
|
|
2878
|
+
|**200** | V1SoftwareRelease | - |
|
|
2879
|
+
|
|
2880
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2881
|
+
|
|
2882
|
+
# **v1GetTargetSoftwareReleasesForNode**
|
|
2883
|
+
> Array<V1SoftwareRelease> v1GetTargetSoftwareReleasesForNode()
|
|
2884
|
+
|
|
2885
|
+
Get the target software releases for a node
|
|
2886
|
+
|
|
2887
|
+
### Example
|
|
2888
|
+
|
|
2889
|
+
```typescript
|
|
2890
|
+
import {
|
|
2891
|
+
DefaultApi,
|
|
2892
|
+
Configuration
|
|
2893
|
+
} from '@ourskyai/platform-api';
|
|
2894
|
+
|
|
2895
|
+
const configuration = new Configuration();
|
|
2896
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2897
|
+
|
|
2898
|
+
let lineageId: string; //lineage id (default to undefined)
|
|
2899
|
+
|
|
2900
|
+
const { status, data } = await apiInstance.v1GetTargetSoftwareReleasesForNode(
|
|
2901
|
+
lineageId
|
|
2902
|
+
);
|
|
2903
|
+
```
|
|
2904
|
+
|
|
2905
|
+
### Parameters
|
|
2906
|
+
|
|
2907
|
+
|Name | Type | Description | Notes|
|
|
2908
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2909
|
+
| **lineageId** | [**string**] | lineage id | defaults to undefined|
|
|
2910
|
+
|
|
2911
|
+
|
|
2912
|
+
### Return type
|
|
2913
|
+
|
|
2914
|
+
**Array<V1SoftwareRelease>**
|
|
2915
|
+
|
|
2916
|
+
### Authorization
|
|
2917
|
+
|
|
2918
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2919
|
+
|
|
2920
|
+
### HTTP request headers
|
|
2921
|
+
|
|
2922
|
+
- **Content-Type**: Not defined
|
|
2923
|
+
- **Accept**: application/json
|
|
2924
|
+
|
|
2925
|
+
|
|
2926
|
+
### HTTP response details
|
|
2927
|
+
| Status code | Description | Response headers |
|
|
2928
|
+
|-------------|-------------|------------------|
|
|
2929
|
+
|**200** | V1SoftwareRelease[] | - |
|
|
2930
|
+
|
|
2931
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2932
|
+
|
|
2933
|
+
# **v1GetTimeWindowedAsset**
|
|
2934
|
+
> V1TimeWindowedAsset v1GetTimeWindowedAsset()
|
|
2935
|
+
|
|
2936
|
+
Get a time windowed asset by id.
|
|
2937
|
+
|
|
2938
|
+
### Example
|
|
2939
|
+
|
|
2940
|
+
```typescript
|
|
2941
|
+
import {
|
|
2942
|
+
DefaultApi,
|
|
2943
|
+
Configuration
|
|
2944
|
+
} from '@ourskyai/platform-api';
|
|
2945
|
+
|
|
2946
|
+
const configuration = new Configuration();
|
|
2947
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2948
|
+
|
|
2949
|
+
let timeWindowedAssetId: string; // (default to undefined)
|
|
2950
|
+
|
|
2951
|
+
const { status, data } = await apiInstance.v1GetTimeWindowedAsset(
|
|
2952
|
+
timeWindowedAssetId
|
|
2953
|
+
);
|
|
2954
|
+
```
|
|
2955
|
+
|
|
2956
|
+
### Parameters
|
|
2957
|
+
|
|
2958
|
+
|Name | Type | Description | Notes|
|
|
2959
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2960
|
+
| **timeWindowedAssetId** | [**string**] | | defaults to undefined|
|
|
2961
|
+
|
|
2962
|
+
|
|
2963
|
+
### Return type
|
|
2964
|
+
|
|
2965
|
+
**V1TimeWindowedAsset**
|
|
2966
|
+
|
|
2967
|
+
### Authorization
|
|
2968
|
+
|
|
2969
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2970
|
+
|
|
2971
|
+
### HTTP request headers
|
|
2972
|
+
|
|
2973
|
+
- **Content-Type**: Not defined
|
|
2974
|
+
- **Accept**: application/json
|
|
2975
|
+
|
|
2976
|
+
|
|
2977
|
+
### HTTP response details
|
|
2978
|
+
| Status code | Description | Response headers |
|
|
2979
|
+
|-------------|-------------|------------------|
|
|
2980
|
+
|**200** | V1TimeWindowedAsset | - |
|
|
2981
|
+
|
|
2982
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2983
|
+
|
|
2984
|
+
# **v1IssueCertificate**
|
|
2985
|
+
> V1NodeControllerIssueCertificateResponse v1IssueCertificate(v1NodeControllerBootstrapRequest)
|
|
2986
|
+
|
|
2987
|
+
issueCertificate
|
|
2988
|
+
|
|
2989
|
+
### Example
|
|
2990
|
+
|
|
2991
|
+
```typescript
|
|
2992
|
+
import {
|
|
2993
|
+
DefaultApi,
|
|
2994
|
+
Configuration,
|
|
2995
|
+
V1NodeControllerBootstrapRequest
|
|
2996
|
+
} from '@ourskyai/platform-api';
|
|
2997
|
+
|
|
2998
|
+
const configuration = new Configuration();
|
|
2999
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3000
|
+
|
|
3001
|
+
let v1NodeControllerBootstrapRequest: V1NodeControllerBootstrapRequest; //
|
|
3002
|
+
|
|
3003
|
+
const { status, data } = await apiInstance.v1IssueCertificate(
|
|
3004
|
+
v1NodeControllerBootstrapRequest
|
|
3005
|
+
);
|
|
3006
|
+
```
|
|
3007
|
+
|
|
3008
|
+
### Parameters
|
|
3009
|
+
|
|
3010
|
+
|Name | Type | Description | Notes|
|
|
3011
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3012
|
+
| **v1NodeControllerBootstrapRequest** | **V1NodeControllerBootstrapRequest**| | |
|
|
3013
|
+
|
|
3014
|
+
|
|
3015
|
+
### Return type
|
|
3016
|
+
|
|
3017
|
+
**V1NodeControllerIssueCertificateResponse**
|
|
3018
|
+
|
|
3019
|
+
### Authorization
|
|
3020
|
+
|
|
3021
|
+
No authorization required
|
|
3022
|
+
|
|
3023
|
+
### HTTP request headers
|
|
3024
|
+
|
|
3025
|
+
- **Content-Type**: application/json
|
|
3026
|
+
- **Accept**: application/json
|
|
3027
|
+
|
|
3028
|
+
|
|
3029
|
+
### HTTP response details
|
|
3030
|
+
| Status code | Description | Response headers |
|
|
3031
|
+
|-------------|-------------|------------------|
|
|
3032
|
+
|**200** | V1NodeControllerIssueCertificateResponse | - |
|
|
3033
|
+
|
|
3034
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3035
|
+
|
|
3036
|
+
# **v1Logout**
|
|
3037
|
+
> EmptySuccess v1Logout()
|
|
3038
|
+
|
|
3039
|
+
User initiated logout - revokes existing _user_ access tokens for the principal
|
|
3040
|
+
|
|
3041
|
+
### Example
|
|
3042
|
+
|
|
3043
|
+
```typescript
|
|
3044
|
+
import {
|
|
3045
|
+
DefaultApi,
|
|
3046
|
+
Configuration
|
|
3047
|
+
} from '@ourskyai/platform-api';
|
|
3048
|
+
|
|
3049
|
+
const configuration = new Configuration();
|
|
3050
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3051
|
+
|
|
3052
|
+
const { status, data } = await apiInstance.v1Logout();
|
|
3053
|
+
```
|
|
3054
|
+
|
|
3055
|
+
### Parameters
|
|
3056
|
+
This endpoint does not have any parameters.
|
|
3057
|
+
|
|
3058
|
+
|
|
3059
|
+
### Return type
|
|
3060
|
+
|
|
3061
|
+
**EmptySuccess**
|
|
3062
|
+
|
|
3063
|
+
### Authorization
|
|
3064
|
+
|
|
3065
|
+
[BearerToken](../README.md#BearerToken)
|
|
3066
|
+
|
|
3067
|
+
### HTTP request headers
|
|
3068
|
+
|
|
3069
|
+
- **Content-Type**: Not defined
|
|
3070
|
+
- **Accept**: application/json
|
|
3071
|
+
|
|
3072
|
+
|
|
3073
|
+
### HTTP response details
|
|
3074
|
+
| Status code | Description | Response headers |
|
|
3075
|
+
|-------------|-------------|------------------|
|
|
3076
|
+
|**200** | Successful action | - |
|
|
3077
|
+
|
|
3078
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3079
|
+
|
|
3080
|
+
# **v1MountMatch**
|
|
3081
|
+
> Array<V1Mount> v1MountMatch()
|
|
3082
|
+
|
|
3083
|
+
Match mount.
|
|
3084
|
+
|
|
3085
|
+
### Example
|
|
3086
|
+
|
|
3087
|
+
```typescript
|
|
3088
|
+
import {
|
|
3089
|
+
DefaultApi,
|
|
3090
|
+
Configuration
|
|
3091
|
+
} from '@ourskyai/platform-api';
|
|
3092
|
+
|
|
3093
|
+
const configuration = new Configuration();
|
|
3094
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3095
|
+
|
|
3096
|
+
let model: string; // (optional) (default to undefined)
|
|
3097
|
+
|
|
3098
|
+
const { status, data } = await apiInstance.v1MountMatch(
|
|
3099
|
+
model
|
|
3100
|
+
);
|
|
3101
|
+
```
|
|
3102
|
+
|
|
3103
|
+
### Parameters
|
|
3104
|
+
|
|
3105
|
+
|Name | Type | Description | Notes|
|
|
3106
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3107
|
+
| **model** | [**string**] | | (optional) defaults to undefined|
|
|
3108
|
+
|
|
3109
|
+
|
|
3110
|
+
### Return type
|
|
3111
|
+
|
|
3112
|
+
**Array<V1Mount>**
|
|
3113
|
+
|
|
3114
|
+
### Authorization
|
|
3115
|
+
|
|
3116
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3117
|
+
|
|
3118
|
+
### HTTP request headers
|
|
3119
|
+
|
|
3120
|
+
- **Content-Type**: Not defined
|
|
3121
|
+
- **Accept**: application/json
|
|
3122
|
+
|
|
3123
|
+
|
|
3124
|
+
### HTTP response details
|
|
3125
|
+
| Status code | Description | Response headers |
|
|
3126
|
+
|-------------|-------------|------------------|
|
|
3127
|
+
|**200** | V1Mount[] | - |
|
|
3128
|
+
|
|
3129
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3130
|
+
|
|
3131
|
+
# **v1NodeCommandV1EnableAutonomousOperation**
|
|
3132
|
+
> SuccessfulCreate v1NodeCommandV1EnableAutonomousOperation(v1EnableAutonomousOperation)
|
|
3133
|
+
|
|
3134
|
+
\' V1EnableAutonomousOperation - immediately places the system back under autonomous operation mode. !!CAUTION!! This will immediately begin slewing your system around if conditions are safe. Please ensure your system is prepared to move \'
|
|
3135
|
+
|
|
3136
|
+
### Example
|
|
3137
|
+
|
|
3138
|
+
```typescript
|
|
3139
|
+
import {
|
|
3140
|
+
DefaultApi,
|
|
3141
|
+
Configuration,
|
|
3142
|
+
V1EnableAutonomousOperation
|
|
3143
|
+
} from '@ourskyai/platform-api';
|
|
3144
|
+
|
|
3145
|
+
const configuration = new Configuration();
|
|
3146
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3147
|
+
|
|
3148
|
+
let v1EnableAutonomousOperation: V1EnableAutonomousOperation; //
|
|
3149
|
+
|
|
3150
|
+
const { status, data } = await apiInstance.v1NodeCommandV1EnableAutonomousOperation(
|
|
3151
|
+
v1EnableAutonomousOperation
|
|
3152
|
+
);
|
|
3153
|
+
```
|
|
3154
|
+
|
|
3155
|
+
### Parameters
|
|
3156
|
+
|
|
3157
|
+
|Name | Type | Description | Notes|
|
|
3158
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3159
|
+
| **v1EnableAutonomousOperation** | **V1EnableAutonomousOperation**| | |
|
|
3160
|
+
|
|
3161
|
+
|
|
3162
|
+
### Return type
|
|
3163
|
+
|
|
3164
|
+
**SuccessfulCreate**
|
|
3165
|
+
|
|
3166
|
+
### Authorization
|
|
3167
|
+
|
|
3168
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3169
|
+
|
|
3170
|
+
### HTTP request headers
|
|
3171
|
+
|
|
3172
|
+
- **Content-Type**: application/json
|
|
3173
|
+
- **Accept**: application/json
|
|
3174
|
+
|
|
3175
|
+
|
|
3176
|
+
### HTTP response details
|
|
3177
|
+
| Status code | Description | Response headers |
|
|
3178
|
+
|-------------|-------------|------------------|
|
|
3179
|
+
|**200** | Successful create | - |
|
|
3180
|
+
|
|
3181
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3182
|
+
|
|
3183
|
+
# **v1NodeCommandV1EnableManualOperation**
|
|
3184
|
+
> SuccessfulCreate v1NodeCommandV1EnableManualOperation(v1EnableManualOperation)
|
|
3185
|
+
|
|
3186
|
+
\' V1EnableManualOperation- immediately halts all autonomous operation of the system and parks the telescope (including closing the enclosure if present). !!CAUTION!! This is an indefinite halt until V1EnableAutonomousOperation is called. Your system will not respond to weather and safety events! \'
|
|
3187
|
+
|
|
3188
|
+
### Example
|
|
3189
|
+
|
|
3190
|
+
```typescript
|
|
3191
|
+
import {
|
|
3192
|
+
DefaultApi,
|
|
3193
|
+
Configuration,
|
|
3194
|
+
V1EnableManualOperation
|
|
3195
|
+
} from '@ourskyai/platform-api';
|
|
3196
|
+
|
|
3197
|
+
const configuration = new Configuration();
|
|
3198
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3199
|
+
|
|
3200
|
+
let v1EnableManualOperation: V1EnableManualOperation; //
|
|
3201
|
+
|
|
3202
|
+
const { status, data } = await apiInstance.v1NodeCommandV1EnableManualOperation(
|
|
3203
|
+
v1EnableManualOperation
|
|
3204
|
+
);
|
|
3205
|
+
```
|
|
3206
|
+
|
|
3207
|
+
### Parameters
|
|
3208
|
+
|
|
3209
|
+
|Name | Type | Description | Notes|
|
|
3210
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3211
|
+
| **v1EnableManualOperation** | **V1EnableManualOperation**| | |
|
|
3212
|
+
|
|
3213
|
+
|
|
3214
|
+
### Return type
|
|
3215
|
+
|
|
3216
|
+
**SuccessfulCreate**
|
|
3217
|
+
|
|
3218
|
+
### Authorization
|
|
3219
|
+
|
|
3220
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3221
|
+
|
|
3222
|
+
### HTTP request headers
|
|
3223
|
+
|
|
3224
|
+
- **Content-Type**: application/json
|
|
3225
|
+
- **Accept**: application/json
|
|
3226
|
+
|
|
3227
|
+
|
|
3228
|
+
### HTTP response details
|
|
3229
|
+
| Status code | Description | Response headers |
|
|
3230
|
+
|-------------|-------------|------------------|
|
|
3231
|
+
|**200** | Successful create | - |
|
|
3232
|
+
|
|
3233
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3234
|
+
|
|
3235
|
+
# **v1NodeCommandV1RebootSystem**
|
|
3236
|
+
> SuccessfulCreate v1NodeCommandV1RebootSystem(v1RebootSystem)
|
|
3237
|
+
|
|
3238
|
+
v1 reboot system
|
|
3239
|
+
|
|
3240
|
+
### Example
|
|
3241
|
+
|
|
3242
|
+
```typescript
|
|
3243
|
+
import {
|
|
3244
|
+
DefaultApi,
|
|
3245
|
+
Configuration,
|
|
3246
|
+
V1RebootSystem
|
|
3247
|
+
} from '@ourskyai/platform-api';
|
|
3248
|
+
|
|
3249
|
+
const configuration = new Configuration();
|
|
3250
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3251
|
+
|
|
3252
|
+
let v1RebootSystem: V1RebootSystem; //
|
|
3253
|
+
|
|
3254
|
+
const { status, data } = await apiInstance.v1NodeCommandV1RebootSystem(
|
|
3255
|
+
v1RebootSystem
|
|
3256
|
+
);
|
|
3257
|
+
```
|
|
3258
|
+
|
|
3259
|
+
### Parameters
|
|
3260
|
+
|
|
3261
|
+
|Name | Type | Description | Notes|
|
|
3262
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3263
|
+
| **v1RebootSystem** | **V1RebootSystem**| | |
|
|
3264
|
+
|
|
3265
|
+
|
|
3266
|
+
### Return type
|
|
3267
|
+
|
|
3268
|
+
**SuccessfulCreate**
|
|
3269
|
+
|
|
3270
|
+
### Authorization
|
|
3271
|
+
|
|
3272
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3273
|
+
|
|
3274
|
+
### HTTP request headers
|
|
3275
|
+
|
|
3276
|
+
- **Content-Type**: application/json
|
|
3277
|
+
- **Accept**: application/json
|
|
3278
|
+
|
|
3279
|
+
|
|
3280
|
+
### HTTP response details
|
|
3281
|
+
| Status code | Description | Response headers |
|
|
3282
|
+
|-------------|-------------|------------------|
|
|
3283
|
+
|**200** | Successful create | - |
|
|
3284
|
+
|
|
3285
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3286
|
+
|
|
3287
|
+
# **v1NodeCommandV1SendFlare**
|
|
3288
|
+
> SuccessfulCreate v1NodeCommandV1SendFlare(v1SendFlare)
|
|
3289
|
+
|
|
3290
|
+
v1 send flare
|
|
3291
|
+
|
|
3292
|
+
### Example
|
|
3293
|
+
|
|
3294
|
+
```typescript
|
|
3295
|
+
import {
|
|
3296
|
+
DefaultApi,
|
|
3297
|
+
Configuration,
|
|
3298
|
+
V1SendFlare
|
|
3299
|
+
} from '@ourskyai/platform-api';
|
|
3300
|
+
|
|
3301
|
+
const configuration = new Configuration();
|
|
3302
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3303
|
+
|
|
3304
|
+
let v1SendFlare: V1SendFlare; //
|
|
3305
|
+
|
|
3306
|
+
const { status, data } = await apiInstance.v1NodeCommandV1SendFlare(
|
|
3307
|
+
v1SendFlare
|
|
3308
|
+
);
|
|
3309
|
+
```
|
|
3310
|
+
|
|
3311
|
+
### Parameters
|
|
3312
|
+
|
|
3313
|
+
|Name | Type | Description | Notes|
|
|
3314
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3315
|
+
| **v1SendFlare** | **V1SendFlare**| | |
|
|
3316
|
+
|
|
3317
|
+
|
|
3318
|
+
### Return type
|
|
3319
|
+
|
|
3320
|
+
**SuccessfulCreate**
|
|
3321
|
+
|
|
3322
|
+
### Authorization
|
|
3323
|
+
|
|
3324
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3325
|
+
|
|
3326
|
+
### HTTP request headers
|
|
3327
|
+
|
|
3328
|
+
- **Content-Type**: application/json
|
|
3329
|
+
- **Accept**: application/json
|
|
3330
|
+
|
|
3331
|
+
|
|
3332
|
+
### HTTP response details
|
|
3333
|
+
| Status code | Description | Response headers |
|
|
3334
|
+
|-------------|-------------|------------------|
|
|
3335
|
+
|**200** | Successful create | - |
|
|
3336
|
+
|
|
3337
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3338
|
+
|
|
3339
|
+
# **v1OAuthAuthorize**
|
|
3340
|
+
> V1OAuthAuthorizeResponse v1OAuthAuthorize(v1OAuthAuthorizeRequest)
|
|
3341
|
+
|
|
3342
|
+
Authorize an OAuth request. Returns a redirect URL with an authorization code.
|
|
3343
|
+
|
|
3344
|
+
### Example
|
|
3345
|
+
|
|
3346
|
+
```typescript
|
|
3347
|
+
import {
|
|
3348
|
+
DefaultApi,
|
|
3349
|
+
Configuration,
|
|
3350
|
+
V1OAuthAuthorizeRequest
|
|
3351
|
+
} from '@ourskyai/platform-api';
|
|
3352
|
+
|
|
3353
|
+
const configuration = new Configuration();
|
|
3354
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3355
|
+
|
|
3356
|
+
let v1OAuthAuthorizeRequest: V1OAuthAuthorizeRequest; //
|
|
3357
|
+
|
|
3358
|
+
const { status, data } = await apiInstance.v1OAuthAuthorize(
|
|
3359
|
+
v1OAuthAuthorizeRequest
|
|
3360
|
+
);
|
|
3361
|
+
```
|
|
3362
|
+
|
|
3363
|
+
### Parameters
|
|
3364
|
+
|
|
3365
|
+
|Name | Type | Description | Notes|
|
|
3366
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3367
|
+
| **v1OAuthAuthorizeRequest** | **V1OAuthAuthorizeRequest**| | |
|
|
3368
|
+
|
|
3369
|
+
|
|
3370
|
+
### Return type
|
|
3371
|
+
|
|
3372
|
+
**V1OAuthAuthorizeResponse**
|
|
3373
|
+
|
|
3374
|
+
### Authorization
|
|
3375
|
+
|
|
3376
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3377
|
+
|
|
3378
|
+
### HTTP request headers
|
|
3379
|
+
|
|
3380
|
+
- **Content-Type**: application/json
|
|
3381
|
+
- **Accept**: application/json
|
|
3382
|
+
|
|
3383
|
+
|
|
3384
|
+
### HTTP response details
|
|
3385
|
+
| Status code | Description | Response headers |
|
|
3386
|
+
|-------------|-------------|------------------|
|
|
3387
|
+
|**200** | V1OAuthAuthorizeResponse | - |
|
|
3388
|
+
|
|
3389
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3390
|
+
|
|
3391
|
+
# **v1OAuthLogout**
|
|
3392
|
+
> EmptySuccess v1OAuthLogout()
|
|
3393
|
+
|
|
3394
|
+
Clear the OAuth refresh token cookie, effectively logging the user out of the OAuth session.
|
|
3395
|
+
|
|
3396
|
+
### Example
|
|
3397
|
+
|
|
3398
|
+
```typescript
|
|
3399
|
+
import {
|
|
3400
|
+
DefaultApi,
|
|
3401
|
+
Configuration
|
|
3402
|
+
} from '@ourskyai/platform-api';
|
|
3403
|
+
|
|
3404
|
+
const configuration = new Configuration();
|
|
3405
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3406
|
+
|
|
3407
|
+
const { status, data } = await apiInstance.v1OAuthLogout();
|
|
3408
|
+
```
|
|
3409
|
+
|
|
3410
|
+
### Parameters
|
|
3411
|
+
This endpoint does not have any parameters.
|
|
3412
|
+
|
|
3413
|
+
|
|
3414
|
+
### Return type
|
|
3415
|
+
|
|
3416
|
+
**EmptySuccess**
|
|
3417
|
+
|
|
3418
|
+
### Authorization
|
|
3419
|
+
|
|
3420
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3421
|
+
|
|
3422
|
+
### HTTP request headers
|
|
3423
|
+
|
|
3424
|
+
- **Content-Type**: Not defined
|
|
3425
|
+
- **Accept**: application/json
|
|
3426
|
+
|
|
3427
|
+
|
|
3428
|
+
### HTTP response details
|
|
3429
|
+
| Status code | Description | Response headers |
|
|
3430
|
+
|-------------|-------------|------------------|
|
|
3431
|
+
|**200** | Successful action | - |
|
|
3432
|
+
|
|
3433
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3434
|
+
|
|
3435
|
+
# **v1OAuthToken**
|
|
3436
|
+
> V1OAuthTokenResponse v1OAuthToken(v1OAuthTokenRequest)
|
|
3437
|
+
|
|
3438
|
+
OAuth 2.0 token endpoint. Supports grant_type=authorization_code to exchange an authorization code for an access token and refresh token, and grant_type=refresh_token to exchange a refresh token for a new access token and refresh token.
|
|
3439
|
+
|
|
3440
|
+
### Example
|
|
3441
|
+
|
|
3442
|
+
```typescript
|
|
3443
|
+
import {
|
|
3444
|
+
DefaultApi,
|
|
3445
|
+
Configuration,
|
|
3446
|
+
V1OAuthTokenRequest
|
|
3447
|
+
} from '@ourskyai/platform-api';
|
|
3448
|
+
|
|
3449
|
+
const configuration = new Configuration();
|
|
3450
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3451
|
+
|
|
3452
|
+
let v1OAuthTokenRequest: V1OAuthTokenRequest; //
|
|
3453
|
+
|
|
3454
|
+
const { status, data } = await apiInstance.v1OAuthToken(
|
|
3455
|
+
v1OAuthTokenRequest
|
|
3456
|
+
);
|
|
3457
|
+
```
|
|
3458
|
+
|
|
3459
|
+
### Parameters
|
|
3460
|
+
|
|
3461
|
+
|Name | Type | Description | Notes|
|
|
3462
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3463
|
+
| **v1OAuthTokenRequest** | **V1OAuthTokenRequest**| | |
|
|
3464
|
+
|
|
3465
|
+
|
|
3466
|
+
### Return type
|
|
3467
|
+
|
|
3468
|
+
**V1OAuthTokenResponse**
|
|
3469
|
+
|
|
3470
|
+
### Authorization
|
|
3471
|
+
|
|
3472
|
+
No authorization required
|
|
3473
|
+
|
|
3474
|
+
### HTTP request headers
|
|
3475
|
+
|
|
3476
|
+
- **Content-Type**: application/json
|
|
3477
|
+
- **Accept**: application/json
|
|
3478
|
+
|
|
3479
|
+
|
|
3480
|
+
### HTTP response details
|
|
3481
|
+
| Status code | Description | Response headers |
|
|
3482
|
+
|-------------|-------------|------------------|
|
|
3483
|
+
|**200** | V1OAuthTokenResponse | - |
|
|
3484
|
+
|
|
3485
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3486
|
+
|
|
3487
|
+
# **v1RefreshCertificate**
|
|
3488
|
+
> V2NodeControllerIssueCertificateResponse v1RefreshCertificate()
|
|
3489
|
+
|
|
3490
|
+
Refresh certificates for a node controller in FINISHED bootstrap status. For NODE_CONTROLLER role: Uses the lineageId from the authenticated certificate. For ADMIN role: Can optionally specify a lineageId to refresh certificates for any node.
|
|
3491
|
+
|
|
3492
|
+
### Example
|
|
3493
|
+
|
|
3494
|
+
```typescript
|
|
3495
|
+
import {
|
|
3496
|
+
DefaultApi,
|
|
3497
|
+
Configuration,
|
|
3498
|
+
V1RefreshCertificateRequest
|
|
3499
|
+
} from '@ourskyai/platform-api';
|
|
3500
|
+
|
|
3501
|
+
const configuration = new Configuration();
|
|
3502
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3503
|
+
|
|
3504
|
+
let v1RefreshCertificateRequest: V1RefreshCertificateRequest; // (optional)
|
|
3505
|
+
|
|
3506
|
+
const { status, data } = await apiInstance.v1RefreshCertificate(
|
|
3507
|
+
v1RefreshCertificateRequest
|
|
3508
|
+
);
|
|
3509
|
+
```
|
|
3510
|
+
|
|
3511
|
+
### Parameters
|
|
3512
|
+
|
|
3513
|
+
|Name | Type | Description | Notes|
|
|
3514
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3515
|
+
| **v1RefreshCertificateRequest** | **V1RefreshCertificateRequest**| | |
|
|
3516
|
+
|
|
3517
|
+
|
|
3518
|
+
### Return type
|
|
3519
|
+
|
|
3520
|
+
**V2NodeControllerIssueCertificateResponse**
|
|
3521
|
+
|
|
3522
|
+
### Authorization
|
|
3523
|
+
|
|
3524
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3525
|
+
|
|
3526
|
+
### HTTP request headers
|
|
3527
|
+
|
|
3528
|
+
- **Content-Type**: application/json
|
|
3529
|
+
- **Accept**: application/json
|
|
3530
|
+
|
|
3531
|
+
|
|
3532
|
+
### HTTP response details
|
|
3533
|
+
| Status code | Description | Response headers |
|
|
3534
|
+
|-------------|-------------|------------------|
|
|
3535
|
+
|**200** | V2NodeControllerIssueCertificateResponse | - |
|
|
3536
|
+
|**400** | Node not in FINISHED status | - |
|
|
3537
|
+
|**404** | Node controller not found | - |
|
|
3538
|
+
|
|
3539
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3540
|
+
|
|
3541
|
+
# **v1RegisterNodeController**
|
|
3542
|
+
> V1NodeController v1RegisterNodeController(v1RegisterNodeControllerRequest)
|
|
3543
|
+
|
|
3544
|
+
RegisterNodeController
|
|
3545
|
+
|
|
3546
|
+
### Example
|
|
3547
|
+
|
|
3548
|
+
```typescript
|
|
3549
|
+
import {
|
|
3550
|
+
DefaultApi,
|
|
3551
|
+
Configuration,
|
|
3552
|
+
V1RegisterNodeControllerRequest
|
|
3553
|
+
} from '@ourskyai/platform-api';
|
|
3554
|
+
|
|
3555
|
+
const configuration = new Configuration();
|
|
3556
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3557
|
+
|
|
3558
|
+
let v1RegisterNodeControllerRequest: V1RegisterNodeControllerRequest; //
|
|
3559
|
+
|
|
3560
|
+
const { status, data } = await apiInstance.v1RegisterNodeController(
|
|
3561
|
+
v1RegisterNodeControllerRequest
|
|
3562
|
+
);
|
|
3563
|
+
```
|
|
3564
|
+
|
|
3565
|
+
### Parameters
|
|
3566
|
+
|
|
3567
|
+
|Name | Type | Description | Notes|
|
|
3568
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3569
|
+
| **v1RegisterNodeControllerRequest** | **V1RegisterNodeControllerRequest**| | |
|
|
3570
|
+
|
|
3571
|
+
|
|
3572
|
+
### Return type
|
|
3573
|
+
|
|
3574
|
+
**V1NodeController**
|
|
3575
|
+
|
|
3576
|
+
### Authorization
|
|
3577
|
+
|
|
3578
|
+
No authorization required
|
|
3579
|
+
|
|
3580
|
+
### HTTP request headers
|
|
3581
|
+
|
|
3582
|
+
- **Content-Type**: application/json
|
|
3583
|
+
- **Accept**: application/json
|
|
3584
|
+
|
|
3585
|
+
|
|
3586
|
+
### HTTP response details
|
|
3587
|
+
| Status code | Description | Response headers |
|
|
3588
|
+
|-------------|-------------|------------------|
|
|
3589
|
+
|**200** | V1NodeController | - |
|
|
3590
|
+
|
|
3591
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3592
|
+
|
|
3593
|
+
# **v1RequestMacAddresses**
|
|
3594
|
+
> V1RequestMacAddressesResponse v1RequestMacAddresses(v1RequestMacAddressesRequest)
|
|
3595
|
+
|
|
3596
|
+
Requests mac addresses for the given lineage and interfaces.
|
|
3597
|
+
|
|
3598
|
+
### Example
|
|
3599
|
+
|
|
3600
|
+
```typescript
|
|
3601
|
+
import {
|
|
3602
|
+
DefaultApi,
|
|
3603
|
+
Configuration,
|
|
3604
|
+
V1RequestMacAddressesRequest
|
|
3605
|
+
} from '@ourskyai/platform-api';
|
|
3606
|
+
|
|
3607
|
+
const configuration = new Configuration();
|
|
3608
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3609
|
+
|
|
3610
|
+
let v1RequestMacAddressesRequest: V1RequestMacAddressesRequest; //
|
|
3611
|
+
|
|
3612
|
+
const { status, data } = await apiInstance.v1RequestMacAddresses(
|
|
3613
|
+
v1RequestMacAddressesRequest
|
|
3614
|
+
);
|
|
3615
|
+
```
|
|
3616
|
+
|
|
3617
|
+
### Parameters
|
|
3618
|
+
|
|
3619
|
+
|Name | Type | Description | Notes|
|
|
3620
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3621
|
+
| **v1RequestMacAddressesRequest** | **V1RequestMacAddressesRequest**| | |
|
|
3622
|
+
|
|
3623
|
+
|
|
3624
|
+
### Return type
|
|
3625
|
+
|
|
3626
|
+
**V1RequestMacAddressesResponse**
|
|
3627
|
+
|
|
3628
|
+
### Authorization
|
|
3629
|
+
|
|
3630
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3631
|
+
|
|
3632
|
+
### HTTP request headers
|
|
3633
|
+
|
|
3634
|
+
- **Content-Type**: application/json
|
|
3635
|
+
- **Accept**: application/json
|
|
3636
|
+
|
|
3637
|
+
|
|
3638
|
+
### HTTP response details
|
|
3639
|
+
| Status code | Description | Response headers |
|
|
3640
|
+
|-------------|-------------|------------------|
|
|
3641
|
+
|**200** | Refresh payload | - |
|
|
3642
|
+
|
|
3643
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3644
|
+
|
|
3645
|
+
# **v1StartOTAEncryptionLatest**
|
|
3646
|
+
> V1OTAEncryptionResult v1StartOTAEncryptionLatest(v1OTAEncryptionRequestLatest)
|
|
3647
|
+
|
|
3648
|
+
Start OTA encryption of latest software release for the specified edge controller
|
|
3649
|
+
|
|
3650
|
+
### Example
|
|
3651
|
+
|
|
3652
|
+
```typescript
|
|
3653
|
+
import {
|
|
3654
|
+
DefaultApi,
|
|
3655
|
+
Configuration,
|
|
3656
|
+
V1OTAEncryptionRequestLatest
|
|
3657
|
+
} from '@ourskyai/platform-api';
|
|
3658
|
+
|
|
3659
|
+
const configuration = new Configuration();
|
|
3660
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3661
|
+
|
|
3662
|
+
let v1OTAEncryptionRequestLatest: V1OTAEncryptionRequestLatest; //
|
|
3663
|
+
|
|
3664
|
+
const { status, data } = await apiInstance.v1StartOTAEncryptionLatest(
|
|
3665
|
+
v1OTAEncryptionRequestLatest
|
|
3666
|
+
);
|
|
3667
|
+
```
|
|
3668
|
+
|
|
3669
|
+
### Parameters
|
|
3670
|
+
|
|
3671
|
+
|Name | Type | Description | Notes|
|
|
3672
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3673
|
+
| **v1OTAEncryptionRequestLatest** | **V1OTAEncryptionRequestLatest**| | |
|
|
3674
|
+
|
|
3675
|
+
|
|
3676
|
+
### Return type
|
|
3677
|
+
|
|
3678
|
+
**V1OTAEncryptionResult**
|
|
3679
|
+
|
|
3680
|
+
### Authorization
|
|
3681
|
+
|
|
3682
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3683
|
+
|
|
3684
|
+
### HTTP request headers
|
|
3685
|
+
|
|
3686
|
+
- **Content-Type**: application/json
|
|
3687
|
+
- **Accept**: application/json
|
|
3688
|
+
|
|
3689
|
+
|
|
3690
|
+
### HTTP response details
|
|
3691
|
+
| Status code | Description | Response headers |
|
|
3692
|
+
|-------------|-------------|------------------|
|
|
3693
|
+
|**200** | V1OTAEncryption | - |
|
|
3694
|
+
|
|
3695
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3696
|
+
|
|
3697
|
+
# **v1UpdateNode**
|
|
3698
|
+
> EmptySuccess v1UpdateNode(v1UpdateNodeRequest)
|
|
3699
|
+
|
|
3700
|
+
Update a node.
|
|
3701
|
+
|
|
3702
|
+
### Example
|
|
3703
|
+
|
|
3704
|
+
```typescript
|
|
3705
|
+
import {
|
|
3706
|
+
DefaultApi,
|
|
3707
|
+
Configuration,
|
|
3708
|
+
V1UpdateNodeRequest
|
|
3709
|
+
} from '@ourskyai/platform-api';
|
|
3710
|
+
|
|
3711
|
+
const configuration = new Configuration();
|
|
3712
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3713
|
+
|
|
3714
|
+
let v1UpdateNodeRequest: V1UpdateNodeRequest; //
|
|
3715
|
+
|
|
3716
|
+
const { status, data } = await apiInstance.v1UpdateNode(
|
|
3717
|
+
v1UpdateNodeRequest
|
|
3718
|
+
);
|
|
3719
|
+
```
|
|
3720
|
+
|
|
3721
|
+
### Parameters
|
|
3722
|
+
|
|
3723
|
+
|Name | Type | Description | Notes|
|
|
3724
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3725
|
+
| **v1UpdateNodeRequest** | **V1UpdateNodeRequest**| | |
|
|
3726
|
+
|
|
3727
|
+
|
|
3728
|
+
### Return type
|
|
3729
|
+
|
|
3730
|
+
**EmptySuccess**
|
|
3731
|
+
|
|
3732
|
+
### Authorization
|
|
3733
|
+
|
|
3734
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3735
|
+
|
|
3736
|
+
### HTTP request headers
|
|
3737
|
+
|
|
3738
|
+
- **Content-Type**: application/json
|
|
3739
|
+
- **Accept**: application/json
|
|
3740
|
+
|
|
3741
|
+
|
|
3742
|
+
### HTTP response details
|
|
3743
|
+
| Status code | Description | Response headers |
|
|
3744
|
+
|-------------|-------------|------------------|
|
|
3745
|
+
|**200** | Successful action | - |
|
|
3746
|
+
|
|
3747
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3748
|
+
|
|
3749
|
+
# **v2CompleteObservation**
|
|
3750
|
+
> EmptySuccess v2CompleteObservation(v2CompleteObservationRequest)
|
|
3751
|
+
|
|
3752
|
+
Complete an observation utilizing the async pipeline.
|
|
3753
|
+
|
|
3754
|
+
### Example
|
|
3755
|
+
|
|
3756
|
+
```typescript
|
|
3757
|
+
import {
|
|
3758
|
+
DefaultApi,
|
|
3759
|
+
Configuration,
|
|
3760
|
+
V2CompleteObservationRequest
|
|
3761
|
+
} from '@ourskyai/platform-api';
|
|
3762
|
+
|
|
3763
|
+
const configuration = new Configuration();
|
|
3764
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3765
|
+
|
|
3766
|
+
let v2CompleteObservationRequest: V2CompleteObservationRequest; //
|
|
3767
|
+
|
|
3768
|
+
const { status, data } = await apiInstance.v2CompleteObservation(
|
|
3769
|
+
v2CompleteObservationRequest
|
|
3770
|
+
);
|
|
3771
|
+
```
|
|
3772
|
+
|
|
3773
|
+
### Parameters
|
|
3774
|
+
|
|
3775
|
+
|Name | Type | Description | Notes|
|
|
3776
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3777
|
+
| **v2CompleteObservationRequest** | **V2CompleteObservationRequest**| | |
|
|
3778
|
+
|
|
3779
|
+
|
|
3780
|
+
### Return type
|
|
3781
|
+
|
|
3782
|
+
**EmptySuccess**
|
|
3783
|
+
|
|
3784
|
+
### Authorization
|
|
3785
|
+
|
|
3786
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3787
|
+
|
|
3788
|
+
### HTTP request headers
|
|
3789
|
+
|
|
3790
|
+
- **Content-Type**: application/json
|
|
3791
|
+
- **Accept**: application/json
|
|
3792
|
+
|
|
3793
|
+
|
|
3794
|
+
### HTTP response details
|
|
3795
|
+
| Status code | Description | Response headers |
|
|
3796
|
+
|-------------|-------------|------------------|
|
|
3797
|
+
|**200** | Successful action | - |
|
|
3798
|
+
|
|
3799
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3800
|
+
|
|
3801
|
+
# **v2IssueCertificate**
|
|
3802
|
+
> V2NodeControllerIssueCertificateResponse v2IssueCertificate(v1NodeControllerBootstrapRequest)
|
|
3803
|
+
|
|
3804
|
+
V2 Issue Certificate
|
|
3805
|
+
|
|
3806
|
+
### Example
|
|
3807
|
+
|
|
3808
|
+
```typescript
|
|
3809
|
+
import {
|
|
3810
|
+
DefaultApi,
|
|
3811
|
+
Configuration,
|
|
3812
|
+
V1NodeControllerBootstrapRequest
|
|
3813
|
+
} from '@ourskyai/platform-api';
|
|
3814
|
+
|
|
3815
|
+
const configuration = new Configuration();
|
|
3816
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3817
|
+
|
|
3818
|
+
let v1NodeControllerBootstrapRequest: V1NodeControllerBootstrapRequest; //
|
|
3819
|
+
|
|
3820
|
+
const { status, data } = await apiInstance.v2IssueCertificate(
|
|
3821
|
+
v1NodeControllerBootstrapRequest
|
|
3822
|
+
);
|
|
3823
|
+
```
|
|
3824
|
+
|
|
3825
|
+
### Parameters
|
|
3826
|
+
|
|
3827
|
+
|Name | Type | Description | Notes|
|
|
3828
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3829
|
+
| **v1NodeControllerBootstrapRequest** | **V1NodeControllerBootstrapRequest**| | |
|
|
3830
|
+
|
|
3831
|
+
|
|
3832
|
+
### Return type
|
|
3833
|
+
|
|
3834
|
+
**V2NodeControllerIssueCertificateResponse**
|
|
3835
|
+
|
|
3836
|
+
### Authorization
|
|
3837
|
+
|
|
3838
|
+
No authorization required
|
|
3839
|
+
|
|
3840
|
+
### HTTP request headers
|
|
3841
|
+
|
|
3842
|
+
- **Content-Type**: application/json
|
|
3843
|
+
- **Accept**: application/json
|
|
3844
|
+
|
|
3845
|
+
|
|
3846
|
+
### HTTP response details
|
|
3847
|
+
| Status code | Description | Response headers |
|
|
3848
|
+
|-------------|-------------|------------------|
|
|
3849
|
+
|**200** | V1NodeControllerIssueCertificateResponse | - |
|
|
3850
|
+
|
|
3851
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3852
|
+
|
|
3853
|
+
# **v2UpdateNode**
|
|
3854
|
+
> EmptySuccess v2UpdateNode(v2UpdateNodeRequest)
|
|
3855
|
+
|
|
3856
|
+
Update a node.
|
|
3857
|
+
|
|
3858
|
+
### Example
|
|
3859
|
+
|
|
3860
|
+
```typescript
|
|
3861
|
+
import {
|
|
3862
|
+
DefaultApi,
|
|
3863
|
+
Configuration,
|
|
3864
|
+
V2UpdateNodeRequest
|
|
3865
|
+
} from '@ourskyai/platform-api';
|
|
3866
|
+
|
|
3867
|
+
const configuration = new Configuration();
|
|
3868
|
+
const apiInstance = new DefaultApi(configuration);
|
|
3869
|
+
|
|
3870
|
+
let v2UpdateNodeRequest: V2UpdateNodeRequest; //
|
|
3871
|
+
|
|
3872
|
+
const { status, data } = await apiInstance.v2UpdateNode(
|
|
3873
|
+
v2UpdateNodeRequest
|
|
3874
|
+
);
|
|
3875
|
+
```
|
|
3876
|
+
|
|
3877
|
+
### Parameters
|
|
3878
|
+
|
|
3879
|
+
|Name | Type | Description | Notes|
|
|
3880
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3881
|
+
| **v2UpdateNodeRequest** | **V2UpdateNodeRequest**| | |
|
|
3882
|
+
|
|
3883
|
+
|
|
3884
|
+
### Return type
|
|
3885
|
+
|
|
3886
|
+
**EmptySuccess**
|
|
3887
|
+
|
|
3888
|
+
### Authorization
|
|
3889
|
+
|
|
3890
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
3891
|
+
|
|
3892
|
+
### HTTP request headers
|
|
3893
|
+
|
|
3894
|
+
- **Content-Type**: application/json
|
|
3895
|
+
- **Accept**: application/json
|
|
3896
|
+
|
|
3897
|
+
|
|
3898
|
+
### HTTP response details
|
|
3899
|
+
| Status code | Description | Response headers |
|
|
3900
|
+
|-------------|-------------|------------------|
|
|
3901
|
+
|**200** | Successful action | - |
|
|
3902
|
+
|
|
3903
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3904
|
+
|