Skip to content

Commit

Permalink
Merge pull request #136 from atlanticwave-sdx/135.readme-update-conn-…
Browse files Browse the repository at this point in the history
…request

Update connection request description in README
  • Loading branch information
sajith authored Jul 27, 2023
2 parents 97c4948 + d714ee4 commit 3e9c6c0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 15 deletions.
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,9 @@ Connections.

### Connection Requests

Format of a connection request is in the form of [[Source node,
Destination node, Bandwidth required, Latency required],..]. Here is
an example of a random connection request:

```
[[1,10,8,20],[2,9,10,15],[15,10,6,22]]
```

There are three queries in this connection request. The first one is
`[1,10,8,20]`, and it means this connection query is to route traffic
from Node 1 to Node 10, requring a bandwith of 8 and maximum latency
of 20.
Connection requests should carry an identifier, source, destination,
required bandwidth, and required latency, among other things. They
are in JSON format. For an example, see [test_request.json].


## Working with PCE code
Expand Down Expand Up @@ -130,3 +121,5 @@ Test data is stored in [tests/data](./tests/data) as JSON files.
[OR-Tools]: https://developers.google.com/optimization/

[tox]: https://tox.wiki/en/latest/index.html

[test_request.json]: ./tests/data/test_request.json
6 changes: 3 additions & 3 deletions tests/data/test_request.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"id": "id",
"name": "AMLight",
"id": "test-connection-request",
"name": "Test connection request",
"start_time": "2000-01-23T04:56:07.000Z",
"end_time": "2000-01-23T04:56:07.000Z",
"bandwidth_required": 10,
Expand All @@ -19,4 +19,4 @@
"node": "urn:ogf:network:sdx:node:zaoxi:A1",
"status": "up"
}
}
}

0 comments on commit 3e9c6c0

Please sign in to comment.