Skip to content

Commit

Permalink
fix(spec): correct typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Rotzbua authored and ondratu committed Jan 13, 2025
1 parent 6bd5cd4 commit ce6ffd5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
16 changes: 8 additions & 8 deletions spec/openapi-legacy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ security:
paths:
/api/version:
get:
summary: version informations
summary: version information
parameters:
- in: query
name: system
Expand Down Expand Up @@ -53,7 +53,7 @@ paths:
example: "prusa-sl1"
firmware:
type: string
description: "Firmaware version"
description: "Firmware version"
example: "3.10.0"
sdk:
type: string
Expand Down Expand Up @@ -168,7 +168,7 @@ paths:
# platform dependent
/api/printerprofiles:
get:
summary: Retrive a mock of octoprinter printer profile
summary: Retrieve a mock of octoprinter printer profile
responses:
200:
description: OK
Expand All @@ -184,7 +184,7 @@ paths:

/api/printer:
get:
summary: Retrive the current printer state
summary: Retrieve the current printer state
parameters:
- in: query
name: exclude
Expand Down Expand Up @@ -419,7 +419,7 @@ paths:
# sends Content-Location header with URL to <PCL IP>/error (in the future it may send URL to hlep.prusa3d.com)
/api/printer/error:
get:
summary: Retrive the error number and text. Not compatible with OctoPrint.
summary: Retrieve the error number and text. Not compatible with OctoPrint.
responses:
200:
description: Custom endpoint to get error details. Client can see if printer is in error state by polling /api/printer
Expand Down Expand Up @@ -1643,7 +1643,7 @@ components:
offset:
type: number
nullable: true
description: Currenntly configured temperature offset to apply.
description: Currently configured temperature offset to apply.
example:
actual: 22.5
target: 50.0
Expand Down Expand Up @@ -2268,11 +2268,11 @@ components:
example: "10108"
title:
type: string
description: Prusa error text string with prefiled variable macros.
description: Prusa error text string with prefilled variable macros.
example: "RESIN TOO LOW"
text:
type: string
description: Prusa error text string with prefiled variable macros.
description: Prusa error text string with prefilled variable macros.
example: "Measured resin volume 22.4 ml is lower than required for this print. Refill the tank and restart the print."
url:
type: string
Expand Down
18 changes: 9 additions & 9 deletions spec/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ security:
paths:
/api/version:
get:
summary: api version informations
summary: api version information
responses:
200:
description: OK
Expand All @@ -29,7 +29,7 @@ paths:

/api/v1/info:
get:
summary: printer informations
summary: printer information
responses:
200:
description: OK
Expand Down Expand Up @@ -1011,7 +1011,7 @@ components:
example: 215
brim_width:
type: integer
description: Milimeters
description: Millimeters
example: 0
estimated printing time (normal mode):
type: string
Expand Down Expand Up @@ -1073,7 +1073,7 @@ components:
example: 5
layer_height:
type: number
description: Milimeters
description: Millimeters
example: 0.3
material_name:
type: string
Expand All @@ -1100,13 +1100,13 @@ components:
example: 1
nozzle_diameter:
type: number
description: Milimeters
description: Millimeters
example: 0.4
nozzle_diameter per tool:
type: array
items:
type: number
description: Milimeters
description: Millimeters
example: 0.4
normal_percent_present:
type: boolean
Expand Down Expand Up @@ -1409,7 +1409,7 @@ components:
example: 42.25
transferred:
type: integer
description: Transfered data in bytes
description: Transferred data in bytes
example: 3276800
time_remaining:
type: integer
Expand Down Expand Up @@ -1521,11 +1521,11 @@ components:
example: "10108"
title:
type: string
description: Prusa error text string with prefiled variable macros.
description: Prusa error text string with prefilled variable macros.
example: "RESIN TOO LOW"
text:
type: string
description: Prusa error text string with prefiled variable macros.
description: Prusa error text string with prefilled variable macros.
example: "Measured resin volume 22.4 ml is lower than required for this print. Refill the tank and restart the print."
url:
type: string
Expand Down

0 comments on commit ce6ffd5

Please sign in to comment.