Skip to content

Commit

Permalink
ipauser: Add note on attributes 'first' and 'last' requirements
Browse files Browse the repository at this point in the history
Attributes 'first' and 'last' are required if user does not exist, but
current documentation doesn't make it clear. This patch adds a note on
both attributes to make clear the cases where the attribute is required
  • Loading branch information
rjeffman committed Aug 25, 2022
1 parent fd79f95 commit bb08884
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,8 +381,8 @@ Variable | Description | Required

Variable | Description | Required
-------- | ----------- | --------
`first` \| `givenname` | The first name string. | no
`last` \| `sn` | The last name string. | no
`first` \| `givenname` | The first name string. Required if user does not exist. | no
`last` \| `sn` | The last name string. Required if user does not exist. | no
`fullname` \| `cn` | The full name string. | no
`displayname` | The display name string. | no
`homedir` | The home directory string. | no
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/ipauser.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@
description: The user (internally uid).
required: true
first:
description: The first name
description: The first name. Required if user does not exist.
required: false
aliases: ["givenname"]
last:
description: The last name
description: The last name. Required if user doesnot exst.
required: false
aliases: ["sn"]
fullname:
Expand Down Expand Up @@ -212,11 +212,11 @@
type: bool
required: false
first:
description: The first name
description: The first name. Required if user does not exist.
required: false
aliases: ["givenname"]
last:
description: The last name
description: The last name. Required if user does not exist.
required: false
aliases: ["sn"]
fullname:
Expand Down

0 comments on commit bb08884

Please sign in to comment.