Skip to content

Commit

Permalink
Merge pull request #69 from RReverser/default-to-example
Browse files Browse the repository at this point in the history 
Replace `default` with `example` in OpenAPI
  • Loading branch information
@Peter-Simpson
Peter-Simpson authored Oct 4, 2024
2 parents bdeb0ca + f9c89cd commit 0be62fc
Showing 1 changed file with 28 additions and 25 deletions.
53 changes: 28 additions & 25 deletions Swagger/AlpacaDeviceAPI_v1.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ paths:
description: The X binning value
type: integer
format: int32
default: 1
example: 1
required:
- BinX
'/camera/{device_number}/biny':
Expand Down Expand Up @@ -571,7 +571,7 @@ paths:
description: The Y binning value
type: integer
format: int32
default: 1
example: 1
required:
- BinY
'/camera/{device_number}/camerastate':
Expand Down Expand Up @@ -811,7 +811,7 @@ paths:
CoolerOn:
description: Cooler state
type: boolean
default: true
example: true
required:
- CoolerOn
'/camera/{device_number}/coolerpower':
Expand Down Expand Up @@ -946,7 +946,7 @@ paths:
FastReadout:
description: True to enable fast readout mode
type: boolean
default: false
example: false
required:
- FastReadout
'/camera/{device_number}/fullwellcapacity':
Expand Down Expand Up @@ -1010,7 +1010,7 @@ paths:
description: Index of the current camera gain in the Gains string array.
type: integer
format: int32
default: 0
example: 0
required:
- Gain
'/camera/{device_number}/gainmax':
Expand Down Expand Up @@ -1496,7 +1496,7 @@ paths:
pixels.
type: integer
format: int32
default: 0
example: 0
required:
- NumX
'/camera/{device_number}/numy':
Expand Down Expand Up @@ -1545,7 +1545,7 @@ paths:
pixels.
type: integer
format: int32
default: 0
example: 0
required:
- NumY
'/camera/{device_number}/offset':
Expand Down Expand Up @@ -1590,7 +1590,7 @@ paths:
description: Index of the current camera offset in the offsets string array.
type: integer
format: int32
default: 0
example: 0
required:
- Offset
'/camera/{device_number}/offsetmax':
Expand Down Expand Up @@ -1747,7 +1747,7 @@ paths:
indicating the camera's current readout mode.
type: integer
format: int32
default: 0
example: 0
required:
- ReadoutMode
'/camera/{device_number}/readoutmodes':
Expand Down Expand Up @@ -1849,7 +1849,7 @@ paths:
SetCCDTemperature:
description: Temperature set point (degrees Celsius).
type: number
default: -10
example: -10
required:
- SetCCDTemperature
'/camera/{device_number}/startx':
Expand Down Expand Up @@ -1895,7 +1895,7 @@ paths:
description: The subframe X axis start position in binned pixels.
type: integer
format: int32
default: 0
example: 0
required:
- StartX
'/camera/{device_number}/starty':
Expand Down Expand Up @@ -1941,7 +1941,7 @@ paths:
description: The subframe Y axis start position in binned pixels.
type: integer
format: int32
default: 0
example: 0
required:
- StartY
'/camera/{device_number}/subexposureduration':
Expand Down Expand Up @@ -1987,7 +1987,7 @@ paths:
SubExposureDuration:
description: The request sub exposure duration in seconds
type: number
default: 0
example: 0
required:
- SubExposureDuration
'/camera/{device_number}/abortexposure':
Expand Down Expand Up @@ -2581,7 +2581,7 @@ paths:
Slaved:
description: 'True if telescope is slaved to dome, otherwise false'
type: boolean
default: false
example: false
required:
- Slaved
'/dome/{device_number}/slewing':
Expand Down Expand Up @@ -3135,7 +3135,7 @@ paths:
AveragePeriod:
description: Time period (hours) over which to average sensor readings
type: number
default: 0.15
example: 0.15
required:
- AveragePeriod
'/observingconditions/{device_number}/cloudcover':
Expand Down Expand Up @@ -3407,7 +3407,7 @@ paths:
required: true
schema:
type: string
default: Pressure
example: Pressure
- $ref: '#/components/parameters/ClientIDQuery'
- $ref: '#/components/parameters/ClientTransactionIDQuery'
tags:
Expand All @@ -3433,7 +3433,7 @@ paths:
required: true
schema:
type: string
default: Pressure
example: Pressure
- $ref: '#/components/parameters/ClientIDQuery'
- $ref: '#/components/parameters/ClientTransactionIDQuery'
tags:
Expand Down Expand Up @@ -5534,7 +5534,7 @@ paths:
Rate:
description: The rate of motion (deg/sec) about the specified axis
type: number
default: 0
example: 0
required:
- Axis
- Rate
Expand Down Expand Up @@ -5587,7 +5587,7 @@ paths:
description: The duration of the guide-rate motion (milliseconds)
type: integer
format: int32
default: 5
example: 5
required:
- Direction
- Duration
Expand Down Expand Up @@ -5842,7 +5842,10 @@ components:
schema:
type: integer
format: uint32
default: 0
example: 0
minimum: 0
maximum: 4294967295

ClientIDQuery:
name: ClientID
description: Client's unique ID. (1 to 4294967295). The client should choose a value at start-up, e.g. a random value between 1 and 65535, and send this on every transaction to associate entries in device logs with this particular client. Zero is a reserved value that clients should not use.
Expand All @@ -5851,7 +5854,7 @@ components:
schema:
type: integer
format: uint32
default: 1
example: 123
minimum: 1
ClientTransactionIDQuery:
name: ClientTransactionID
Expand All @@ -5861,7 +5864,7 @@ components:
schema:
type: integer
format: uint32
default: 1234
example: 1234
minimum: 1
RightAscensionQuery:
name: RightAscension
Expand Down Expand Up @@ -5889,7 +5892,7 @@ components:
schema:
type: integer
format: int32
default: 0
example: 0
minimum: 0
requestBodies:
put_devicetype_Devicenumber_commandblind:
Expand Down Expand Up @@ -6482,13 +6485,13 @@ components:
RightAscension:
type: number
description: Right Ascension coordinate (0.0 to 23.99999999 hours)
default: 3.0
example: 3.0
minimum: 0.0
maximum: 23.9999999999
Declination:
description: Declination coordinate (-90.0 to +90.0 degrees)
type: number
default: 0.0
example: 0.0
minimum: -90.0
maximum: 90.0
PierSide:
Expand Down

0 comments on commit 0be62fc

Please sign in to comment.