reformat with latest settings
Reformat with the latest settings from openbmc-build-scripts (and
copy latest config files where appropriate). Fix a few minor
markdownlint issues.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I55205817c29dc3f182a165ddf9cd5d4e07b90063
diff --git a/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml b/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
index 75a7695..d0fc5ee 100644
--- a/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
@@ -1,7 +1,7 @@
description: >
- Implement to update LDAP mandatory properties.
- Any service implementing User.Ldap.Config interface on one or more
- objects must implement Object.Enable interface on the object.
+ Implement to update LDAP mandatory properties. Any service implementing
+ User.Ldap.Config interface on one or more objects must implement
+ Object.Enable interface on the object.
properties:
- name: LDAPServerURI
@@ -24,15 +24,14 @@
type: string
description: >
Specifies the credentials with which to bind,Implementation should
- consider changing the permissions of the underlying file to
- only grant access to the root user.
- This property value should not be reflected on the D-bus object itself.
- Implementation can use the given value and update the service
- implementing the LDAP client.This is just to facilitate the support
- for changing the bin dn password if needed.
- Currently this property is over D-bus, There are security concerns
- for the same, but once we find better way to update the ldap password
- we would fix it.
+ consider changing the permissions of the underlying file to only grant
+ access to the root user. This property value should not be reflected
+ on the D-bus object itself. Implementation can use the given value and
+ update the service implementing the LDAP client.This is just to
+ facilitate the support for changing the bin dn password if needed.
+ Currently this property is over D-bus, There are security concerns for
+ the same, but once we find better way to update the ldap password we
+ would fix it.
- name: LDAPBaseDN
type: string
description: >
@@ -51,24 +50,23 @@
type: enum[self.Type]
description: >
Specifies the the configured server is ActiveDirectory(AD) or
- OpenLdap. It's just an indication for the LDAP stack running on
- the BMC, in case the app is implemented in such a way that it has
- to react differently for AD vs openldap.
- This property is readonly, Once the D-Bus object gets created then
- this property should not be modifiable.
+ OpenLdap. It's just an indication for the LDAP stack running on the
+ BMC, in case the app is implemented in such a way that it has to react
+ differently for AD vs openldap. This property is readonly, Once the
+ D-Bus object gets created then this property should not be modifiable.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
- xyz.openbmc_project.Common.Error.NotAllowed
- name: GroupNameAttribute
type: string
description: >
- The value of this property shall be the attribute name
- that contains the name of the Group in the LDAP server.
+ The value of this property shall be the attribute name that contains
+ the name of the Group in the LDAP server.
- name: UserNameAttribute
type: string
description: >
- The value of this property shall be the attribute name
- that contains the username in the LDAP server.
+ The value of this property shall be the attribute name that contains
+ the username in the LDAP server.
enumerations:
- name: SearchScope
description: >
diff --git a/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml b/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
index 452bd9e..fae5b8b 100644
--- a/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
@@ -4,10 +4,10 @@
methods:
- name: CreateConfig
description: >
- This method always creates a new config file as well as a D-Bus
- object to represent the config, it will destroy an existing one,
- if found. In other words, this is not an update API. Individual
- properties can be updated as per the
+ This method always creates a new config file as well as a D-Bus object
+ to represent the config, it will destroy an existing one, if found. In
+ other words, this is not an update API. Individual properties can be
+ updated as per the
xyz/openbmc_project/User/Ldap/Config.interface.yaml.
parameters:
- name: LDAPServerURI
@@ -37,18 +37,18 @@
description: >
Specifies the the configured server is ActiveDirectory(AD) or
OpenLdap. It's just an indication for the LDAP stack running on
- the BMC, in case the app is implemented in such a way that it has
- to react differently for AD vs openldap.
+ the BMC, in case the app is implemented in such a way that it
+ has to react differently for AD vs openldap.
- name: GroupNameAttribute
type: string
description: >
- Specifies the attribute name that contains the name
- of the Group in the LDAP server.
+ Specifies the attribute name that contains the name of the Group
+ in the LDAP server.
- name: UsernameAttribute
type: string
description: >
- Specifies the attribute name that contains
- the username in the LDAP server.
+ Specifies the attribute name that contains the username in the
+ LDAP server.
returns:
- name: path
type: string