Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add browsable AsyncAPI documentation #2

Open
wants to merge 1 commit into
base: lars/SW-73966
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/fire-alarm/css/asyncapi.min.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/fire-alarm/css/global.min.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
html{-moz-tab-size:4;-o-tab-size:4;tab-size:4;line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0;font-family:system-ui,-apple-system,Segoe UI,Roboto,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji}
48 changes: 48 additions & 0 deletions docs/fire-alarm/index.html

Large diffs are not rendered by default.

41 changes: 41 additions & 0 deletions docs/fire-alarm/js/asyncapi-ui.min.js

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions docs/magazinoVDA5050/css/asyncapi.min.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/magazinoVDA5050/css/global.min.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
html{-moz-tab-size:4;-o-tab-size:4;tab-size:4;line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0;font-family:system-ui,-apple-system,Segoe UI,Roboto,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji}
1,235 changes: 1,235 additions & 0 deletions docs/magazinoVDA5050/index.html

Large diffs are not rendered by default.

41 changes: 41 additions & 0 deletions docs/magazinoVDA5050/js/asyncapi-ui.min.js

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
html{-moz-tab-size:4;-o-tab-size:4;tab-size:4;line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0;font-family:system-ui,-apple-system,Segoe UI,Roboto,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji}
394 changes: 394 additions & 0 deletions docs/masterControllerEnvironmentDeployment/index.html

Large diffs are not rendered by default.

41 changes: 41 additions & 0 deletions docs/masterControllerEnvironmentDeployment/js/asyncapi-ui.min.js

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions docs/mfmFrontend/css/asyncapi.min.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/mfmFrontend/css/global.min.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
html{-moz-tab-size:4;-o-tab-size:4;tab-size:4;line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0;font-family:system-ui,-apple-system,Segoe UI,Roboto,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji}
158 changes: 158 additions & 0 deletions docs/mfmFrontend/index.html

Large diffs are not rendered by default.

41 changes: 41 additions & 0 deletions docs/mfmFrontend/js/asyncapi-ui.min.js

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions docs/mfmNodeRED/css/asyncapi.min.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/mfmNodeRED/css/global.min.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
html{-moz-tab-size:4;-o-tab-size:4;tab-size:4;line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0;font-family:system-ui,-apple-system,Segoe UI,Roboto,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji}
306 changes: 306 additions & 0 deletions docs/mfmNodeRED/index.html

Large diffs are not rendered by default.

41 changes: 41 additions & 0 deletions docs/mfmNodeRED/js/asyncapi-ui.min.js

Large diffs are not rendered by default.

65 changes: 36 additions & 29 deletions fire-alarm/0.0.1/asyncapi.yaml → fire-alarm/0.13.0/asyncapi.yaml
Original file line number Diff line number Diff line change
@@ -1,35 +1,42 @@
asyncapi: "2.5.0"

asyncapi: 2.5.0
info:
title: Firealarm specification
version: "0.0.1"
description: |
Definition of the firealarm API between a fire alarm system and Magazino Fleet Manager.
version: 0.0.1
description: >
Definition of the firealarm API between a fire alarm system and Magazino
Fleet Manager.


The fire alarm system connects to the MQTT broker and sets its last will to
the state "offline" on the state topic.

Afterwards, depending on the state of the fire alarm system, either the
state "ok" or "alarm" (in case of an alarm) is published.

The fire alarm system connects to the MQTT broker and sets its last will to the state "offline" on the state topic.
Afterwards, depending on the state of the fire alarm system, either the state "ok" or "alarm" (in case of an alarm) is published.

The keep-alive of 60 seconds ensures that the Magazino Fleet Manager can treat the absense of the fire alarm system like the alarm state and start the respective procedures.
The keep-alive of 60 seconds ensures that the Magazino Fleet Manager can
treat the absense of the fire alarm system like the alarm state and start
the respective procedures.
contact:
name: Markus Grimm
email: [email protected]
url: https://www.magazino.eu
license:
name: proprietary

servers:
production:
url: 'mqtts://{customer}.magazino.eu/mqtt'
url: mqtts://{customer}.magazino.eu/mqtt
protocol: secure-mqtt
description: MQTT broker
variables:
customer:
description: Name of the customer
security:
- x509: []
- x509: []
bindings:
mqtt:
clientId: {fireAlarmSystem}
clientId:
fireAlarmSystem: null
cleanSession: true
lastWill:
topic: firealarm/v2/magazino/{fireAlarmSystem}/state
Expand All @@ -42,62 +49,62 @@ servers:
properties:
state:
type: string
enum: ["offline"]
enum:
- offline
description: State of the fire alarm system (offline)
keepAlive: 60
bindingVersion: 0.1.0

defaultContentType: application/json

channels:
firealarm/v2/magazino/{fireAlarmSystem}/state:
description: |
Topic that the firealarm system offers to provide its state.
parameters:
fireAlarmSystem:
$ref: "#/components/parameters/fireAlarmSystem"
$ref: '#/components/parameters/fireAlarmSystem'
subscribe:
summary: Published by the fire alarm system in case of a firealarm
description: Depending on the state of the fire alarm system, either the state "ok" or "alarm" (in case of an alarm) is published
description: >-
Depending on the state of the fire alarm system, either the state "ok"
or "alarm" (in case of an alarm) is published
operationId: signalUpdate
message:
$ref: "#/components/messages/fireAlarmState"
$ref: '#/components/messages/fireAlarmState'
bindings:
mqtt:
qos: 2
retain: true

components:
messages:
fireAlarmState:
name: fireAlarmState
title: State of the fire alarm system
summary: State of the fire alarm system
payload:
$ref: "#/components/schemas/fireAlarmState"

$ref: '#/components/schemas/fireAlarmState'
schemas:
fireAlarmState:
$schema: https://json-schema.org/draft/2020-12/schema
$schema: http://json-schema.org/draft-07/schema#
$id: magazinoFireAlarm.schema.json
title: fireAlarmState
description: State of the fire alarm system
type: object
required:
- state
- state
properties:
state:
description: State of the fire alarm system
type: string
title: fireAlarmStates
enum:
- offline
- ok
- alarm

- offline
- ok
- alarm
description: State of the fire alarm system
parameters:
fireAlarmSystem:
description: The name of the fire alarm system.
schema:
type: string

securitySchemes:
x509:
type: X509
Loading