CitraClient.Schemas.OpticalObservationCreate (citra_client v0.3.0)

View Source

Schema for creating optical observations - excludes auto-generated fields

Fields

  • :angular_noise — number() (API key: angularNoise)
  • :angular_rate_noise — number() (API key: angularRateNoise)
  • :declination — number()
  • :declination_rate — number() (API key: declinationRate)
  • :epoch — DateTime.t()
  • :max_wavelength — number() (API key: maxWavelength)
  • :min_wavelength — number() (API key: minWavelength)
  • :right_ascension — number() (API key: rightAscension)
  • :right_ascension_rate — number() (API key: rightAscensionRate)
  • :satellite_id — UUID String.t() (API key: satelliteId)
  • :sensor_altitude — number() (API key: sensorAltitude)
  • :sensor_latitude — number() (API key: sensorLatitude)
  • :sensor_longitude — number() (API key: sensorLongitude)
  • :task_id — UUID String.t() (API key: taskId)
  • :telescope_id — UUID String.t() (API key: telescopeId)
  • :visual_magnitude — number() (API key: visualMagnitude)

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.OpticalObservationCreate{
  angular_noise: number() | nil,
  angular_rate_noise: number() | nil,
  declination: number() | nil,
  declination_rate: number() | nil,
  epoch: DateTime.t() | nil,
  max_wavelength: number() | nil,
  min_wavelength: number() | nil,
  right_ascension: number() | nil,
  right_ascension_rate: number() | nil,
  satellite_id: String.t() | nil,
  sensor_altitude: number() | nil,
  sensor_latitude: number() | nil,
  sensor_longitude: number() | nil,
  task_id: String.t() | nil,
  telescope_id: String.t() | nil,
  visual_magnitude: number() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.