Commit 5515057c by Robbie Hott

Re-fixed the markdown syntax in Server API.md

parent ac73fdea
...@@ -24,12 +24,12 @@ Requests should be of the form: ...@@ -24,12 +24,12 @@ Requests should be of the form:
* `command` : the request command, such as `search`. A full list of available options is available [here]() * `command` : the request command, such as `search`. A full list of available options is available [here]()
* `constellation` : all available parts of the constellation to enact the command over. If the interaction does not utilize a constellation, this may be omitted. The full specification for the constellation structure may be viewed [here](). * `constellation` : all available parts of the constellation to enact the command over. If the interaction does not utilize a constellation, this may be omitted. The full specification for the constellation structure may be viewed [here]().
* Example: to request a constellation, the client may use the portions of the constellation that are known (`id` or `ark_id`) * Example: to request a constellation, the client may use the portions of the constellation that are known (`id` or `ark_id`)
```json
{ {
"command" : "get", "command" : "get",
"constellation" : {"id" : 12345} "constellation" : {"id" : 12345}
} }
```
## Server Responses ## Server Responses
...@@ -59,7 +59,7 @@ The Server response API has the following form: ...@@ -59,7 +59,7 @@ The Server response API has the following form:
* `type` : the type of the error. A full list of error types are defined [here](http://shannonvm.village.virginia.edu:83). * `type` : the type of the error. A full list of error types are defined [here](http://shannonvm.village.virginia.edu:83).
* `message` : a detailed error message (in English prose) stating the exact nature of the problem * `message` : a detailed error message (in English prose) stating the exact nature of the problem
* `constellation` : The matching constellation for the client's query. All portions of the constellation known to the server will be returned to the client. If there are multiple constellations, this will return a list: * `constellation` : The matching constellation for the client's query. All portions of the constellation known to the server will be returned to the client. If there are multiple constellations, this will return a list:
```json
{ {
"constellation" : [ "constellation" : [
{ "...":"..." }, { "...":"..." },
...@@ -67,4 +67,4 @@ The Server response API has the following form: ...@@ -67,4 +67,4 @@ The Server response API has the following form:
{ "...":"..." } { "...":"..." }
] ]
} }
```
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment