@ourskyai/platform-api
v1.4.130
Published
OpenAPI client for @ourskyai/platform-api
Maintainers
Readme
@ourskyai/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @ourskyai/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://api.prod.oursky.ai
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DefaultApi | getCameraRoll | GET /v1/camera-roll | DefaultApi | getClientToken | GET /v1/client-tokens | DefaultApi | v1CameraMatch | GET /v1/camera-match | DefaultApi | v1CompleteBootstrap | POST /v1/node-controller/completeBootstrap | DefaultApi | v1CompleteNodeControllerCrashReport | POST /v1/node-controller/complete-crash-report | DefaultApi | v1CompleteNodeFlare | POST /v1/node-flare/complete | DefaultApi | v1CompleteObservation | PUT /v1/observation-complete | DefaultApi | v1CreateAllSkyPrediction | POST /v1/all-sky-prediction | DefaultApi | v1CreateAutofocusResult | POST /v1/autofocus | DefaultApi | v1CreateImageMetadata | POST /v1/image-metadata | DefaultApi | v1CreateImageSet | POST /v1/image-set | DefaultApi | v1CreateImageSetImage | POST /v1/image-set-image | DefaultApi | v1CreateImageSetImageUploadUrl | POST /v1/image-set-image/upload-url | DefaultApi | v1CreateMetrics | POST /v1/metrics | DefaultApi | v1CreateNode | POST /v1/node | DefaultApi | v1CreateNodeControllerArtifact | PUT /v1/node-controller-artifact | DefaultApi | v1CreateNodeControllerCrashReport | POST /v1/node-controller/crash-report | DefaultApi | v1CreateNodeDiagnostics | POST /v1/node-diagnostics | DefaultApi | v1CreateNodeEvents | POST /v1/node-events | DefaultApi | v1CreateNodeFlare | POST /v1/node-flare | DefaultApi | v1CreateProcessedImageSetImage | POST /v1/image-set-image/processed | DefaultApi | v1CreateTimeWindowedAsset | POST /v1/time-windowed-asset | DefaultApi | v1CustomerGetSuntimes | GET /v1/suntimes | DefaultApi | v1DeleteImageSet | DELETE /v1/image-set | DefaultApi | v1DeleteImageSetImage | DELETE /v1/image-set-image | DefaultApi | v1DeleteNodeCommand | DELETE /v1/node-command | DefaultApi | v1DownloadCertificateBundle | POST /v1/node-controller/download-certificate-bundle | DefaultApi | v1FocuserMatch | GET /v1/focuser-match | DefaultApi | v1GenerateEdgeToken | POST /v1/edge-token | DefaultApi | v1GetAllSkyImageForImage | GET /v1/all-sky-image-for-image | DefaultApi | v1GetAllSkyPrediction | GET /v1/all-sky-prediction | DefaultApi | v1GetCameras | GET /v1/cameras | DefaultApi | v1GetImageMetadata | GET /v1/image-metadata | DefaultApi | v1GetImageSet | GET /v1/image-set | DefaultApi | v1GetImageSetImage | GET /v1/image-set-image | DefaultApi | v1GetInstruction | PUT /v1/instruction | DefaultApi | v1GetLastInstructionByNodeId | GET /v1/instruction | DefaultApi | v1GetLatestHfr | GET /v1/autofocus | DefaultApi | v1GetLatestModel | GET /v1/ml/get-latest-model | DefaultApi | v1GetMergedNodeConfigBody | GET /v1/node-config | DefaultApi | v1GetNode | GET /v1/node | DefaultApi | v1GetNodeCommands | GET /v1/node-commands | DefaultApi | v1GetNodeDiagnosticTasks | GET /v1/node-diagnostic-tasks | DefaultApi | v1GetNodeEventsApexChartsTimeline | GET /v1/node-events/timeline | DefaultApi | v1GetNodeFlare | GET /v1/node-flare/complete | DefaultApi | v1GetNodes | GET /v1/nodes | DefaultApi | v1GetOTAEncryption | GET /v1/encrypt-ota | DefaultApi | v1GetOpticalTube | GET /v1/optical-tube | DefaultApi | v1GetOrCreateCamera | PUT /v1/camera-match | DefaultApi | v1GetOrCreateFocuser | PUT /v1/focuser-match | DefaultApi | v1GetOrCreateMount | PUT /v1/mount-match | DefaultApi | v1GetPlateSolveCatalogDiff | PUT /v1/plate-solve-catalog-diff | DefaultApi | v1GetSkyAtlasSatellites | GET /v1/sky-atlas/satellites | DefaultApi | v1GetTargetQCOMOTASoftwareReleaseForNode | GET /v1/node-controller-releases | DefaultApi | v1GetTargetSoftwareReleasesForNode | GET /v1/node/target-software-releases | DefaultApi | v1GetTimeWindowedAsset | GET /v1/time-windowed-asset | DefaultApi | v1IssueCertificate | POST /v1/node-controller/issueCertificate | DefaultApi | v1Logout | POST /v1/logout | DefaultApi | v1MountMatch | GET /v1/mount-match | DefaultApi | v1NodeCommandV1EnableAutonomousOperation | POST /v1/node-command/enable-autonomous-operation | DefaultApi | v1NodeCommandV1EnableManualOperation | POST /v1/node-command/enable-manual-operation | DefaultApi | v1NodeCommandV1RebootSystem | POST /v1/node-command/reboot | DefaultApi | v1NodeCommandV1SendFlare | POST /v1/node-command/send-flare | DefaultApi | v1OAuthAuthorize | POST /v1/oauth/authorize | DefaultApi | v1OAuthLogout | POST /v1/oauth/logout | DefaultApi | v1OAuthToken | POST /v1/oauth/token | DefaultApi | v1RefreshCertificate | POST /v1/node-controller/refresh-certificate | DefaultApi | v1RegisterNodeController | POST /v1/node-controller/register | DefaultApi | v1RequestMacAddresses | POST /v1/node-controller/request-mac-addresses | DefaultApi | v1StartOTAEncryptionLatest | POST /v1/encrypt-ota | DefaultApi | v1UpdateNode | PUT /v1/node | DefaultApi | v2CompleteObservation | PUT /v2/observation-complete | DefaultApi | v2IssueCertificate | POST /v2/node-controller/issue-certificate | DefaultApi | v2UpdateNode | PUT /v2/node |
Documentation For Models
- CameraMode
- EmptySuccess
- FilterType
- FitsHeader
- ImageSetType
- Location
- MetricType
- ModelType
- MountGeometry
- MountType
- NetworkInterface
- NodeState
- OrbitType
- PKICertificate
- PlateSolveParameters
- ShutterType
- StreakExtractionSource
- SuccessfulCreate
- TrackingType
- UploadPriority
- V1AccessToken
- V1AccessTokenType
- V1AllSkyCameraConfig
- V1AllSkyImageForImage
- V1AllSkyPrediction
- V1AllSkyPredictionLabel
- V1ApexChartsTimeline
- V1ApexChartsTimelineElement
- V1AssetSize
- V1AutoFocusInstruction
- V1AutoFocusInstructionCoordinatesInner
- V1BlackoutBox
- V1Camera
- V1CameraRollImage
- V1ClientToken
- V1CompleteNodeControllerCrashReportRequest
- V1CompleteNodeFlareRequest
- V1CompleteObservationRequest
- V1CreateAllSkyPredictionRequest
- V1CreateAutofocusResultRequest
- V1CreateImageMetadataRequest
- V1CreateImageSetImageRequest
- V1CreateImageSetImageResponse
- V1CreateImageSetImageUploadUrlRequest
- V1CreateImageSetImageUploadUrlResponse
- V1CreateImageSetRequest
- V1CreateNodeControllerArtifactRequest
- V1CreateNodeControllerCrashReportRequest
- V1CreateNodeControllerCrashReportResponse
- V1CreateNodeDiagnostic
- V1CreateNodeDiagnosticsRequest
- V1CreateNodeEvent
- V1CreateNodeEventsRequest
- V1CreateNodeFlareRequest
- V1CreateNodeFlareResponse
- V1CreateNodeRequest
- V1CreateProcessedImageSetImageRequest
- V1CreateTimeWindowedAssetRequest
- V1CreateTimeWindowedAssetResponse
- V1DataSource
- V1DiagnosticInstruction
- V1DisableDebugServices
- V1DurationMeasured
- V1ElevationMaskPoint
- V1EnableAutonomousOperation
- V1EnableDebugServices
- V1EnableManualOperation
- V1FileType
- V1Focuser
- V1GainCurve
- V1GainCurvePoint
- V1GenerateEdgeTokenResponse
- V1GetInstructionRequest
- V1GetInstructionRequestUploadHealth
- V1GetNodeCommandsResponse
- V1GetNodes
- V1GetOrCreateCameraRequest
- V1GetOrCreateFocuserRequest
- V1GetOrCreateMountRequest
- V1GetPlateSolveCatalogDiffRequest
- V1GetSuntimesResponse
- V1HFRStar
- V1ImageFileType
- V1ImageMetadata
- V1ImageRejectionReason
- V1ImageSet
- V1ImageSetImage
- V1ImageSetImageDot
- V1ImageSetImageStreak
- V1Instruction
- V1JobStatus
- V1LastInstructionResponse
- V1LatestHfrResponse
- V1LogRecorded
- V1MLModel
- V1MatchedStar
- V1Metric
- V1Mount
- V1Node
- V1NodeCommand
- V1NodeComponentType
- V1NodeConfigBody
- V1NodeConfigKeyMetadata
- V1NodeConfigScopeType
- V1NodeController
- V1NodeControllerArtifact
- V1NodeControllerBootstrapRequest
- V1NodeControllerIssueCertificateResponse
- V1NodeControllerIssueCertificateResponseRsaKeyPair
- V1NodeControllerMacAddressesInner
- V1NodeControllerStatus
- V1NodeDiagnosticType
- V1NodeEventType
- V1NodeFlare
- V1NodeWithLocation
- V1OAuthAuthorizeRequest
- V1OAuthAuthorizeResponse
- V1OAuthTokenRequest
- V1OAuthTokenResponse
- V1OTAEncryptionRequestLatest
- V1OTAEncryptionResult
- V1ObservationInstruction
- V1ObservationInstructionAscomAxisRates
- V1ObservationInstructionSatellitePassEphemerisInner
- V1ObservationMetrics
- V1OpticalTube
- V1PixelCoordinates
- V1PlateSolveCatalogFile
- V1PlateSolveCatalogFileDownload
- V1PlateSolveResult
- V1PlateSolveStatus
- V1PredictedStreakLocation
- V1PrincipalRoleType
- V1ProductRevision
- V1ReadNoisePoint
- V1RebootSystem
- V1RefreshCertificateRequest
- V1RegisterNodeControllerRequest
- V1RequestMacAddressesRequest
- V1RequestMacAddressesResponse
- V1RequestMacAddressesResponseMacAddressesInner
- V1ResolvedInstruction
- V1SIPCoefficients
- V1SafetyStatusUpdated
- V1SendFlare
- V1SetupAction
- V1SoftwarePackageType
- V1SoftwareRelease
- V1SoftwareRuntimeEnvironmentType
- V1SystemVariant
- V1TerrestrialDownlinkInstruction
- V1TimeWindowedAsset
- V1TimeWindowedAssetType
- V1Transformation
- V1UpdateNodeRequest
- V1VideoModeFramerateProperty
- V2CompleteObservationRequest
- V2NodeControllerIssueCertificateResponse
- V2UpdateNodeRequest
Documentation For Authorization
Authentication schemes defined for the API:
BearerToken
- Type: Bearer authentication
