diff options
| author | Adriana Kobylak <anoo@us.ibm.com> | 2018-06-06 10:49:24 -0500 |
|---|---|---|
| committer | Brad Bishop <bradleyb@fuzziesquirrel.com> | 2018-06-12 17:40:00 +0000 |
| commit | 75a2e25322abee603dc51032c734a27bfd4df90d (patch) | |
| tree | 80fd192cfdf9db0a00b23ba474611a27346ff717 /docs | |
| parent | ee6ac694c3e21b24ebd2f32ef55249c5eb44bccd (diff) | |
| download | sdbusplus-75a2e25322abee603dc51032c734a27bfd4df90d.tar.gz sdbusplus-75a2e25322abee603dc51032c734a27bfd4df90d.zip | |
property: Add errors support
Add errors support for properties.
Closes openbmc/openbmc#1641
Tested: Verified that when an interface threw a defined property
error, the generated code caught it and returned an error to
the REST call.
Change-Id: I8cb8c77995026f12e373291822e4e0a623a84d81
Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/interface.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/interface.md b/docs/interface.md index 89820b1..1613021 100644 --- a/docs/interface.md +++ b/docs/interface.md @@ -141,8 +141,9 @@ methods: ## Properties A property must have the YAML property `name` and `type` and may optionally -have `description` and `default`. The `default` defines the default value of -the property. +have `description`, `default`, and `errors`. The `default` defines the default +value of the property. See the `Methods` section above for more information on +errors. Example: ``` @@ -152,6 +153,8 @@ properties: default: 52 description: > The number of cards remaining in the deck. + errors: + - self.Error.InvalidNumber ``` ## Signals |
