yaml: format with prettier
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I193f690f3612fe72ec69030f81f4d5096a761601
diff --git a/yaml/xyz/openbmc_project/User/Common.errors.yaml b/yaml/xyz/openbmc_project/User/Common.errors.yaml
index 2bcfb38..ed93ca1 100644
--- a/yaml/xyz/openbmc_project/User/Common.errors.yaml
+++ b/yaml/xyz/openbmc_project/User/Common.errors.yaml
@@ -15,4 +15,4 @@
description: No resource available.
# xyz.openbmc_project.User.Common.Error.PrivilegeMappingExists
- name: PrivilegeMappingExists
- description: Specified privilege mapping already exists.
\ No newline at end of file
+ description: Specified privilege mapping already exists.
diff --git a/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml b/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
index d7af2e8..75a7695 100644
--- a/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
@@ -9,17 +9,17 @@
description: >
Specifies the LDAP URI of the server to connect to.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.Common.Error.NoCACertificate
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.NoCACertificate
- name: LDAPBindDN
type: string
description: >
Specifies the distinguished name with which to bind to the directory
server for lookups.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: LDAPBindDNPassword
type: string
description: >
@@ -38,15 +38,15 @@
description: >
Specifies the base distinguished name to use as search base.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
- name: LDAPSearchScope
type: enum[self.SearchScope]
description: >
Specifies the search scope:subtree, one level or base object.
default: sub
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InternalFailure
- name: LDAPType
type: enum[self.Type]
description: >
@@ -57,8 +57,8 @@
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
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.NotAllowed
- name: GroupNameAttribute
type: string
description: >
@@ -74,13 +74,13 @@
description: >
Possible base scopes.
values:
- - name: sub
- - name: one
- - name: base
+ - name: sub
+ - name: one
+ - name: base
- name: Type
description: >
Possible LDAP Types.
values:
- - name: ActiveDirectory
- - name: OpenLdap
+ - name: ActiveDirectory
+ - name: OpenLdap
diff --git a/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml b/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
index 62a5ec4..452bd9e 100644
--- a/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
@@ -10,68 +10,68 @@
properties can be updated as per the
xyz/openbmc_project/User/Ldap/Config.interface.yaml.
parameters:
- - name: LDAPServerURI
- type: string
- description: >
- Specifies the LDAP URI of the server to connect to.
- - name: LDAPBindDN
- type: string
- description: >
- Specifies the distinguished name with which to bind to the
- directory server for lookups.
- - name: LDAPBaseDN
- type: string
- description: >
- Specifies the base distinguished name to use as search base.
- - name: LDAPBINDDNpassword
- type: string
- description: >
- Specifies the clear text credentials with which to bind. This
- option is only applicable when used with LDAPBindDN.
- - name: LDAPSearchScope
- type: enum[self.SearchScope]
- description: >
- Specifies the search scope:subtree, one level or base object.
- - name: LDAPType
- 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.
- - name: GroupNameAttribute
- type: string
- description: >
- 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.
+ - name: LDAPServerURI
+ type: string
+ description: >
+ Specifies the LDAP URI of the server to connect to.
+ - name: LDAPBindDN
+ type: string
+ description: >
+ Specifies the distinguished name with which to bind to the
+ directory server for lookups.
+ - name: LDAPBaseDN
+ type: string
+ description: >
+ Specifies the base distinguished name to use as search base.
+ - name: LDAPBINDDNpassword
+ type: string
+ description: >
+ Specifies the clear text credentials with which to bind. This
+ option is only applicable when used with LDAPBindDN.
+ - name: LDAPSearchScope
+ type: enum[self.SearchScope]
+ description: >
+ Specifies the search scope:subtree, one level or base object.
+ - name: LDAPType
+ 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.
+ - name: GroupNameAttribute
+ type: string
+ description: >
+ 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.
returns:
- - name: path
- type: string
- description: >
- The object path of the D-Bus object representing the config.
+ - name: path
+ type: string
+ description: >
+ The object path of the D-Bus object representing the config.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.Common.Error.NoCACertificate
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.NoCACertificate
enumerations:
- name: SearchScope
description: >
Possible base scopes.
values:
- - name: sub
- - name: one
- - name: base
+ - name: sub
+ - name: one
+ - name: base
- name: Type
description: >
Possible LDAP Types.
values:
- - name: ActiveDirectory
- - name: OpenLdap
+ - name: ActiveDirectory
+ - name: OpenLdap
diff --git a/yaml/xyz/openbmc_project/User/Manager.interface.yaml b/yaml/xyz/openbmc_project/User/Manager.interface.yaml
index f14c53e..532f7af 100644
--- a/yaml/xyz/openbmc_project/User/Manager.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Manager.interface.yaml
@@ -9,53 +9,53 @@
Creates a new user. If the user already exists, then it will throw
an error.
parameters:
- - name: UserName
- type: string
- description: >
- User name which has to be created.
- - name: GroupNames
- type: array[string]
- description: >
- List of groups to which the user has to be added.
- - name: Privilege
- type: string
- description: >
- Privilege of the user to be added.
- - name: Enabled
- type: boolean
- description: >
- User enabled / disabled.
+ - name: UserName
+ type: string
+ description: >
+ User name which has to be created.
+ - name: GroupNames
+ type: array[string]
+ description: >
+ List of groups to which the user has to be added.
+ - name: Privilege
+ type: string
+ description: >
+ Privilege of the user to be added.
+ - name: Enabled
+ type: boolean
+ description: >
+ User enabled / disabled.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InsufficientPermission
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.User.Common.Error.UserNameExists
- - xyz.openbmc_project.User.Common.Error.UserNameGroupFail
- - xyz.openbmc_project.User.Common.Error.UserNamePrivFail
- - xyz.openbmc_project.User.Common.Error.NoResource
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InsufficientPermission
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.User.Common.Error.UserNameExists
+ - xyz.openbmc_project.User.Common.Error.UserNameGroupFail
+ - xyz.openbmc_project.User.Common.Error.UserNamePrivFail
+ - xyz.openbmc_project.User.Common.Error.NoResource
- name: RenameUser
description: >
Rename's existing user to new one. All other properties of the
user will remain same.
parameters:
- - name: UserName
- type: string
- description: >
- User name which has to be updated.
- - name: NewUserName
- type: string
- description: >
- New User name to which user has to be updated.
+ - name: UserName
+ type: string
+ description: >
+ User name which has to be updated.
+ - name: NewUserName
+ type: string
+ description: >
+ New User name to which user has to be updated.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InsufficientPermission
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist
- - xyz.openbmc_project.User.Common.Error.UserNameExists
- - xyz.openbmc_project.User.Common.Error.UserNameGroupFail
- - xyz.openbmc_project.User.Common.Error.UserNamePrivFail
- - xyz.openbmc_project.User.Common.Error.NoResource
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InsufficientPermission
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist
+ - xyz.openbmc_project.User.Common.Error.UserNameExists
+ - xyz.openbmc_project.User.Common.Error.UserNameGroupFail
+ - xyz.openbmc_project.User.Common.Error.UserNamePrivFail
+ - xyz.openbmc_project.User.Common.Error.NoResource
- name: GetUserInfo
description: >
@@ -71,34 +71,34 @@
-user privilege
-remote user flag
parameters:
- - name: UserName
- type: string
- description: >
- User name whose properties have to be returned.
+ - name: UserName
+ type: string
+ description: >
+ User name whose properties have to be returned.
returns:
- - name: UserInfo
- type: dict[string,variant[string,array[string],boolean]]
- description: >
- Dictionary of user properties.
- List of key name and data type of properties below.
- UserPrivilege -> privilege of the user(string)
- UserGroups -> list of groups user belongs to(array[string])
- UserEnabled -> user enabled state(boolean)
- UserLockedForFailedAttempt -> user locked state(boolean)
- UserPasswordExpired -> user password expired(boolean)
- RemoteUser -> remote or local user(boolean)
+ - name: UserInfo
+ type: dict[string,variant[string,array[string],boolean]]
+ description: >
+ Dictionary of user properties.
+ List of key name and data type of properties below.
+ UserPrivilege -> privilege of the user(string)
+ UserGroups -> list of groups user belongs to(array[string])
+ UserEnabled -> user enabled state(boolean)
+ UserLockedForFailedAttempt -> user locked state(boolean)
+ UserPasswordExpired -> user password expired(boolean)
+ RemoteUser -> remote or local user(boolean)
- For detailed documentation of user properties refer
- Attributes.interface.yaml
- examples:
- 1.UserInfo["RemoteUser"] returns true for ldap user
- and false for local user.
- 2.UserInfo["UserGroups"] gets list of groups of user.
+ For detailed documentation of user properties refer
+ Attributes.interface.yaml
+ examples:
+ 1.UserInfo["RemoteUser"] returns true for ldap user
+ and false for local user.
+ 2.UserInfo["UserGroups"] gets list of groups of user.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InsufficientPermission
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InsufficientPermission
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.User.Common.Error.UserNameDoesNotExist
properties:
- name: AllPrivileges
@@ -118,11 +118,11 @@
signals:
- name: UserRenamed
description: >
- Signal indicating user's name is updated.
+ Signal indicating user's name is updated.
properties:
- - name: UserName
- type: string
- description: Name of the user which got renamed.
- - name: NewUserName
- type: string
- description: New name of the user.
+ - name: UserName
+ type: string
+ description: Name of the user which got renamed.
+ - name: NewUserName
+ type: string
+ description: New name of the user.
diff --git a/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml b/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
index 87b2872..ef28b45 100644
--- a/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
@@ -20,25 +20,25 @@
description: >
Creates a mapping for the group to the privilege.
parameters:
- - name: GroupName
- type: string
- description: >
- Group Name to which the privilege is to be assigned. In the case
- of LDAP, the GroupName will be the LDAP group the user is part of.
- - name: Privilege
- type: string
- description: >
- The privilege associated with the group. The set of available
- privileges are xyz.openbmc_project.User.Manager.AllPrivileges.
- xyz.openbmc_project.Common.Error.InvalidArgument exception will
- be thrown if the privilege is invalid. Additional documentation
- on privilege is available here.
- https://github.com/openbmc/docs/blob/master/architecture/user-management.md
+ - name: GroupName
+ type: string
+ description: >
+ Group Name to which the privilege is to be assigned. In the case
+ of LDAP, the GroupName will be the LDAP group the user is part of.
+ - name: Privilege
+ type: string
+ description: >
+ The privilege associated with the group. The set of available
+ privileges are xyz.openbmc_project.User.Manager.AllPrivileges.
+ xyz.openbmc_project.Common.Error.InvalidArgument exception will
+ be thrown if the privilege is invalid. Additional documentation
+ on privilege is available here.
+ https://github.com/openbmc/docs/blob/master/architecture/user-management.md
returns:
- - name: Path
- type: path
- description: >
- The path for the created privilege mapping object.
+ - name: Path
+ type: path
+ description: >
+ The path for the created privilege mapping object.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml b/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml
index e629982..4217b91 100644
--- a/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml
@@ -8,9 +8,9 @@
Group Name to which the privilege is to be assigned. In the case of
LDAP, the GroupName will be the LDAP group the user is part of.
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
- - xyz.openbmc_project.User.Common.Error.PrivilegeMappingExists
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.User.Common.Error.PrivilegeMappingExists
- name: Privilege
type: string
description: >
@@ -22,5 +22,5 @@
https://github.com/openbmc/docs/blob/master/architecture/user-management.md
errors:
- - xyz.openbmc_project.Common.Error.InternalFailure
- - xyz.openbmc_project.Common.Error.InvalidArgument
+ - xyz.openbmc_project.Common.Error.InternalFailure
+ - xyz.openbmc_project.Common.Error.InvalidArgument