Skip to content

Commit

Permalink
Update the polling_time documentation (#64)
Browse files Browse the repository at this point in the history
Update the description of ``polling_time`` endpoint in the API documentation,
making it explicit that the change made at runtime through the
REST endpoint ``polling_time`` is not persistent.
  • Loading branch information
cmagnobarbosa authored Mar 16, 2021
1 parent 624845d commit 72622e5
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ paths:
example: # Child of media type because we use $ref above
# Properties of a referenced object
interfaces: ["00:00:00:00:00:00:00:04:65534","00:00:00:00:00:00:00:03:65534"]


/v1/interfaces/enable/:
post:
summary: Enable interfaces to receive lldp packet.
Expand All @@ -50,7 +50,7 @@ paths:
$ref: '#/components/schemas/Lista'
'400':
description: No interfaces were found.

/v1/interfaces/disable/:
post:
summary: Disable Interfaces
Expand Down Expand Up @@ -81,7 +81,7 @@ paths:
summary: Get LLDP Polling time.
description: Get LLDP polling time in seconds.
operationId: time_lldp

responses:
'200':
description: OK
Expand All @@ -92,11 +92,11 @@ paths:
example: {"polling_time": 3}

post:
summary: Set the LLDP polling time.
description: Update LLDP polling time.
summary: Update the LLDP polling time at runtime.
description: Update LLDP polling time at runtime, this change is not persistent.
operationId: update_polling_time
requestBody:
description: Update polling time
description: The new LLDP polling time in seconds.
required: true
content:
application/json:
Expand Down Expand Up @@ -125,4 +125,3 @@ components:
type: array
items:
$ref: '#/components/schemas/Lista'

0 comments on commit 72622e5

Please sign in to comment.