Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 508 #509

Merged
merged 2 commits into from
Jun 11, 2024
Merged

Issue 508 #509

merged 2 commits into from
Jun 11, 2024

Conversation

jschlackman
Copy link
Contributor

@jschlackman jschlackman commented Apr 5, 2024

Description

Makes corrections to one of the examples in the Set-JiraUser cmdlet documentation and adds a note to the documentation for the -Property parameter of that cmdlets regarding accepted capitalization of user property names.

Motivation and Context

Fixes #508

This resolves a mistake in the example code and provides important information about the camel case capitalization that is required by the JIRA API. Without this information users may attempt to submit property changes using a different capitalization format (e.g. Pascal case which is used in the objects returned by the various Get- cmdlets in JiraPS). Using the wrong capitalization may result in a No value found to be changed. error being returned.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • I have added Pester Tests that describe what my changes should do.
  • I have updated the documentation accordingly.

Corrected example #2 to use correct parameter name and valid capitalization for the property names in the hashtable.
Added note to the Property parameter regarding accepted capitalization of user property names. Fixes #508.
@jschlackman jschlackman requested a review from a team as a code owner April 5, 2024 14:55
Copy link
Member

@lipkau lipkau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

damn... I would have loved a test for something like this.
But it makes no sense to write mock code for such a server behaviour.

Thank you for your PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Set-JiraUser with Property parameter fails with error 'Invoke-JiraMethod : No value found to be changed.'
2 participants