Skip to content

Commit

Permalink
docs: add server object to element-definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Friso committed Mar 18, 2020
1 parent 3b94815 commit 6f683ac
Showing 1 changed file with 49 additions and 1 deletion.
50 changes: 49 additions & 1 deletion docs/element-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -1118,6 +1118,53 @@ Data structure definition using Data Structure elements.
- `"messageBody"` - Asset is an example of message-body
- `"messageBodySchema"` - Asset is a schema for message-body

### Server ([Object][])

Subtype of [Object][] representing a server.

#### Template

- `element` - `"server"`
- `attributes`
- `href` ([Templated Href][]) - URI Template for this server.
- `hrefVariables` ([Href Variables][]) - URI Template variables.

#### Example

```json
{
"element": "server",
"meta": {
"description": {
"element": "string",
"content": "Description of the server."
}
},
"attributes": {
"href": {
"element": "string",
"content": "{basePath}://example.com/"
},
"hrefVariables": {
"element": "hrefVariables",
"content": [
{
"element": "member",
"content": {
"key": {
"element": "string",
"content": "basePath"
}
}
}
]
}
},
"content": [
]
}
```

### Resource

The Resource representation with its available transitions and its data.
Expand Down Expand Up @@ -1289,7 +1336,8 @@ transitions.
- `"dataStructures"` - Category is a set of data structures.
- `"scenario"` - Category is set of steps.
- `"transitions"` - Category is a group of transitions.
- `"authSchemes"` - Category is a group of authentication and authorization scheme definitions
- `"authSchemes"` - Category is a group of authentication and authorization scheme definitions.
- `"servers"` - Category is a group of servers.

#### Example

Expand Down

0 comments on commit 6f683ac

Please sign in to comment.