-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add first version of swagger documentation
- Loading branch information
1 parent
15770ca
commit d8a7552
Showing
3 changed files
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
openapi: "3.0.3" | ||
info: | ||
title: "Load Flow Service API" | ||
description: "An API that interacts with Powsybl" | ||
version: "1.0.0" | ||
servers: | ||
- url: "http://0.0.0.0:8080" | ||
paths: | ||
/get-buses: | ||
post: | ||
operationId: getBuses | ||
description: "Return all buses in the network" | ||
requestBody: | ||
description: "Form with network sent as file" | ||
required: true | ||
content: | ||
multipart/form-data: | ||
schema: | ||
type: object | ||
properties: | ||
network: | ||
type: string | ||
format: binary | ||
responses: | ||
"200": | ||
description: "List with all buses in the network" | ||
content: | ||
application/json: | ||
schema: | ||
type: array | ||
items: | ||
$ref: "#/components/schemas/Bus" | ||
|
||
|
||
components: | ||
schemas: | ||
Bus: | ||
type: object | ||
properties: | ||
id: | ||
type: string | ||
voltage: | ||
type: double | ||
angle: | ||
type: double | ||
activePower: | ||
type: double | ||
reactivePower: | ||
type: double |