From a10a90bcbf4188c15aba5c38716969c7a5cc2e63 Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Sun, 15 Apr 2018 22:02:59 +0200 Subject: [PATCH 1/7] Remove old files --- docs/Makefile | 20 --- docs/authentication.rst | 52 ------- docs/auto.bat | 1 - docs/changelog.rst | 222 --------------------------- docs/conf.py | 168 -------------------- docs/contributing.rst | 58 ------- docs/creating_issues.rst | 58 ------- docs/custom_fields.rst | 91 ----------- docs/getting_started.rst | 41 ----- docs/img/jira-screen-createIssue.png | Bin 41594 -> 0 bytes docs/index.rst | 48 ------ docs/make.bat | 36 ----- docs/updating_issues.rst | 108 ------------- 13 files changed, 903 deletions(-) delete mode 100644 docs/Makefile delete mode 100644 docs/authentication.rst delete mode 100644 docs/auto.bat delete mode 100644 docs/changelog.rst delete mode 100644 docs/conf.py delete mode 100644 docs/contributing.rst delete mode 100644 docs/creating_issues.rst delete mode 100644 docs/custom_fields.rst delete mode 100644 docs/getting_started.rst delete mode 100644 docs/img/jira-screen-createIssue.png delete mode 100644 docs/index.rst delete mode 100644 docs/make.bat delete mode 100644 docs/updating_issues.rst diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 24fb7085..00000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXPROJ = JiraPS -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/authentication.rst b/docs/authentication.rst deleted file mode 100644 index 8a9ae036..00000000 --- a/docs/authentication.rst +++ /dev/null @@ -1,52 +0,0 @@ -============== -Authentication -============== - -At present, there are two main methods of authenticating to JIRA: HTTP basic authentication, and session-based authentication, which uses HTTP basic authentication once and preserves a session cookie. - -.. warning:: Be sure to set JIRA up to use HTTPS with a valid SSL certificate if you are concerned about security! - -HTTP Basic -========== - -Each JiraPS function that queries a JIRA instance provides a -Credential parameter. Simply pass your JIRA credentials to this parameter. - -.. code-block:: powershell - - $cred = Get-Credential 'powershell' - Get-JiraIssue TEST-01 -Credential $cred - -HTTP basic authentication is not a secure form of authentication. It uses a Base 64-encoded String of the format "username:password", and passes this string in clear text to JIRA. Because decrypting this string and obtaining the username and password is trivial, the use of HTTPS is critical in any system that needs to remain secure. - -.. note:: For more information on HTTP Basic authentication, see `Basic Access Authentication`_ on Wikipedia. - -Sessions -======== - -JIRA sessions still require HTTP basic authentication once, to create the connection, but in this case a persistent session cookie is saved. This is almost identical to "logging in" to JIRA in a Web browser. - -To create a JIRA session, you can use the New-JiraSession function: - -.. code-block:: powershell - - $cred = Get-Credential 'powershell' - New-JiraSession -Credential $cred - -Once you've created this session, you're done! You don't need to specify it when running other commands - JiraPS will manage this session internally and provide the session cookie to JIRA when needed. This also means your credentials are only sent over the network once. - -To close this session, use this command: - -.. code-block:: powershell - - Get-JiraSession | Remove-JiraSession - -This will close the active "logged in" session with JIRA. - -.. note:: It is a good practice to close JIRA sessions when you're done using them. JIRA will eventually time these sessions out, but there is a limit to how many sessions can be open at a given time. - -What About OAuth? -================= - -JIRA does support use of OAuth, but JiraPS does not yet. This is a to-do item! - -.. _Basic Access Authentication: https://en.wikipedia.org/wiki/Basic_access_authentication diff --git a/docs/auto.bat b/docs/auto.bat deleted file mode 100644 index 26228e18..00000000 --- a/docs/auto.bat +++ /dev/null @@ -1 +0,0 @@ -sphinx-autobuild . _build\html diff --git a/docs/changelog.rst b/docs/changelog.rst deleted file mode 100644 index b5f7ed8e..00000000 --- a/docs/changelog.rst +++ /dev/null @@ -1,222 +0,0 @@ -========= -Changelog -========= - -Release date: Jun 25, 2017 - -Features --------- - -* ``Get-JiraIssueEditMetadata``: Returns metadata required to create an issue in JIRA (#65, `@lipkau`_) -* ``Get-JiraRemoteLink``: Returns a remote link from a JIRA issue (#80, `@lipkau`_) -* ``Remove-JiraRemoteLink``: Removes a remote link from a JIRA issue (#80, `@lipkau`_) -* ``Get-JiraComponent``: Returns a Component from JIRA (#68, `@axxelG`_) -* ``Add-JiraIssueWorklog``: Add worklog items to an issue (#83, `@jkknorr`_) -* Added support for getting and managing Issue Watchers (``Add-JiraIssueWatcher``, ``Get-JiraIssueWatcher``, ``Remove-JiraIssueWatcher``) (#73, `@ebekker`_) -* Added IssueLink functionality (``Add-JiraIssueLink``, ``Get-JiraIssueLink``, ``Get-JiraIssueLinkType``, ``Remove-JiraIssueLink``) (#131, `@lipkau`_) - -Improvements ------------- - -* ``New-JiraIssue``: *Description* and *Priority* are no longer mandatory (#53, `@brianbunke`_) -* Added property ``Components`` to ``PSjira.Project`` (#68, `@axxelG`_) -* ``Invoke-JiraIssueTransition``: add support for parameters *Fields*, *Comment* and *Assignee* (#38, `@padgers`_) -* Added support for *FixVersion* parameter in ``New-JiraIssue`` and ``Set-JiraIssue`` (#103, `@Dejulia489`_) -* Respect the global ``$PSDefaultParameterValues`` inside the module (#110, `@lipkau`_) -* ``New-JiraSession``: Display warning when login needs CAPTCHA (#111, `@lipkau`_) -* Switched to *Basic Authentication* when generating the session (#116, `@lipkau`_) -* Added more tests for the CI (#142, `@lipkau`_) - -Bug Fixes ---------- - -* ``Invoke-JiraMethod``: Error when Invoke-WebRequest returns '204 No content' (#42, `@colhal`_) -* ``Invoke-JiraIssueTransition``: Error when Invoke-WebRequest returns '204 No content' (#43, `@colhal`_) -* ``Set-JiraIssueLabel``: Forced label property to be an array (#88, `@kittholland`_) -* ``Invoke-JiraMethod``: Send ContentType as Parameter instead of in the Header (#121, `@lukhase`_) - -2.0.0 -===== - -Release date: Jun 24, 2017 - -Changes to the code module --------------------------- - -* Move module to organization ``AtlassianPS`` -* Rename of the module to ``JiraPS`` [**breaking change**} -* Rename of module's custom objects to ``JiraPS.*`` [**breaking change**] - -1.2.5 -===== - -Release date: Aug 08, 2016 - -Improvements ------------- - -* New-JiraIssue: Priority and Description are no longer mandatory (#24, @lipkau) -* New-JiraIssue: Added -Parent parameter for sub-tasks (#29, @ebekker) - -Bug Fixes ---------- - -* ConvertTo-JiraProject: updated for Atlassian's minor wording change of projectCategory (#31, @alexsuslin) -* Invoke-JiraMethod: now uses the -ContentType parameter instead of manually passing the Content-Type header (#19) -* New-JiraIssue: able to create issues without labels again (#21) -* Set-JiraIssue: fixed issue with JSON depth for custom parameters (#17, @ThePSAdmin) -* Various: Fixed issues with ConvertFrom-Json max length with a custom ConvertFrom-Json2 function (#23, @LiamLeane) - -1.2.4 -===== - -Release date: Dec 10, 2015 - -Improvements ------------- - -* Get-JiraGroupMember: now returns all members by default, with support for -MaxResults and -StartIndex parameters (#14) -* Get-JiraIssue: significantly increased performance (#12) - -Bug Fixes ---------- - -* Get-JiraIssue: fixed issue where Get-JiraIssue would only return one result when using -Filter parameter in some cases (#15) -* Invoke-JiraIssueTransition: fixed -Credential parameter (#13) - -1.2.3 -===== - -Release date: Dec 02, 2015 - -Features --------- - -* Get-JiraIssue: added paging support with the -StartIndex and -PageSize parameters. This allows programmatically looping through all issues that match a given search. (#9) - -Improvements ------------- - -* Get-JiraIssue: default behavior has been changed to return all issues via paging when using -Query or -Filter parameters - -Bug Fixes ---------- - -* Invoke-JiraMethod: Fixed issue where non-standard characters were not being parsed correctly from JSON (#7) - -1.2.2 -===== - -Release date: Nov 16, 2015 - -Features --------- - -* Set-JiraIssueLabel: add and remove specific issue labels, or overwrite or clear all labels on an issue (#5) - -Improvements ------------- - -* New-JiraIssue: now has a -Label parameter -* Set-JiraIssue: now has a -Label parameter (this replaces all labels on an issue; use Set-JiraIssueLabel for more fine-grained control) -* Invoke-JiraMethod: handles special UTF-8 characters correctly (#4) - -Bug Fixes ---------- - -* Get-JiraIssueCreateMetadata: now correctly returns the ID of fields as well (#6) - -1.2.1 -===== - -Release date: Oct 26, 2015 - -Improvements ------------- - -* Get-JiraIssueCreateMetadata: changed output type from a generic PSCustomObject to new type PSJira.CreateMetaField -* Get-JiraIssueCreateMetadata: now returns additional properties for field metadata, such as AllowedValues - -1.2.0 -===== - -Release date: Oct 16, 2015 - -Features --------- - -* Get-JiraFilter: get a reference to a JIRA filter, including its JQL and owner - -Improvements ------------- - -* Get-JiraIssue: now supports a -Filter parameter to obtain all issues matching a given filter object or ID - -1.1.1 -===== - -Release date: Oct 08, 2015 - -Improvements ------------- - -* Set-JiraIssue now supports modifying arbitrary fields through the Fields parameter - -1.1.0 -===== - -Release date: Sep 17, 2015 - -Features --------- - -* User management: create and delete users and groups, and modify group memberships - -Improvements ------------- - -* Cleaner error handling in all REST requests; JIRA's error messages should now be passed as PowerShell errors - -Bug Fixes ---------- - -* PSJira.User: ToString() now works as expected - -1.0.0 -===== - -Release date: Aug 5, 2015 - -* Initial release - -Template -======== - -Release date: Jan 1, 2001 - -Features --------- - -Improvements ------------- - -Bug Fixes ---------- - -The format of this changelog is inspired by `Pester's changelog`_, which is in turn inspired by `Vagrant`_. - -.. _`Pester's changelog`: https://github.com/pester/Pester/blob/master/CHANGELOG.md -.. _`Vagrant`: https://github.com/mitchellh/vagrant/blob/master/CHANGELOG.md -.. _`@alexsuslin`: https://github.com/alexsuslin -.. _`@axxelG`: https://github.com/axxelG -.. _`@brianbunke`: https://github.com/brianbunke -.. _`@colhal`: https://github.com/colhal -.. _`@Dejulia489`: https://github.com/Dejulia489 -.. _`@ebekker`: https://github.com/ebekker -.. _`@jkknorr`: https://github.com/jkknorr -.. _`@kittholland`: https://github.com/kittholland -.. _`@LiamLeane`: https://github.com/LiamLeane -.. _`@lipkau`: https://github.com/lipkau -.. _`@lukhase`: https://github.com/lukhase -.. _`@padgers`: https://github.com/padgers -.. _`@ThePSAdmin`: https://github.com/ThePSAdmin diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 285c2a28..00000000 --- a/docs/conf.py +++ /dev/null @@ -1,168 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# JiraPS documentation build configuration file, created by -# sphinx-quickstart on Tue Dec 13 19:31:32 2016. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - -import os - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinx.ext.todo'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'JiraPS' -copyright = '2016, AtlassianPS' -author = 'AtlassianPS' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '2.1.0' -# The full version, including alpha/beta/rc tags. -release = '2.1.0' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -# html_theme = 'alabaster' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = 'JiraPSdoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'JiraPS.tex', 'JiraPS Documentation', - [author] 'manual'), -] - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'JiraPS', 'JiraPS Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'JiraPS', 'JiraPS Documentation', - author, 'JiraPS', 'One line description of project.', - 'Miscellaneous'), -] - -# Use the Readthedocs theme locally, but don't import it if we're in their environment -# https://github.com/snide/sphinx_rtd_theme -# -# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' - -if not on_rtd: # only import and set the theme if we're building docs locally - import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -# otherwise, readthedocs.org uses their theme by default, so no need to specify it diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index a6851b04..00000000 --- a/docs/contributing.rst +++ /dev/null @@ -1,58 +0,0 @@ -====================== -Contributing to JiraPS -====================== - -There are two main areas where JiraPS needs your help: in the module code itself, and in this documentation. - -* :ref:`JiraPS core` -* :ref:`Documentation` - -.. _JiraPS core: - -Module Code -=========== - -The code for JiraPS relies extensively on Pester tests as a sanity check. Pester tests make sure that when a function gets changed, other functions that depend on it don't break due to the change. - -**Pull requests for JiraPS are expected to pass all Pester tests before they will be merged.** - -This is not intended to keep people from contributing to JiraPS...just to ensure that new features and changes don't break existing ones. If you have ideas for improvements but aren't comfortable with Pester, please feel free to submit a pull request. I (or other authors) would be glad to work with you to figure out what's failing and make the necessary changes (whether in your code or in the test code). - -Tests are code, just like the module itself, so it's entirely possible that they need to be fixed or updated when the module changes. Correcting tests is a healthy part of developing a tool, so changes to tests are welcome as well. - -When code does not pass all the tests, it either indicates that there is a problem with the new code in the pull request, or the code requires a change to an existing test that hasn't been made. - -Automated Testing via Pre-Push Hooks ------------------------------------- - -By setting up a pre-push hook in your local Git repository, you can make sure that all Pester tests pass before you push your changes back to GitHub. This is not necessary to contribute, but it can save some frustration all around. - -In your JiraPS workspace, create a file at .git/hooks/pre-push (with no file extension) - -Edit this file in a text editor and add this content: - -.. code:: bash - - #!/bin/sh - echo - #powershell.exe -NoProfile -ExecutionPolicy Bypass -Command "Write-Host 'Invoking Pester' -Fore DarkYellow; Invoke-Pester -EnableExit;" - powershell.exe -NoProfile -ExecutionPolicy Bypass -File "Tools\Pre-Push.ps1" - exit $? - -This won't prevent you from committing with breaking changes, but it will prevent you from pushing changes while there are failing tests. - -.. _Documentation: - -Documentation -============= - -Unlike the main module code, there is very little to be tested in this documentation (the big thing that gets tested is the changelog, to make sure it's kept up-to-date with releases). - -This documentation is found in the /docs/ folder of the main JiraPS repo, and is written in `ReStructured Text`_. This format was chosen mostly due to a deeper integration with ReadTheDocs than Markdown provided on its own, but the Sphinx build engine that processes the RST is quite powerful and supports a lot of interesting features. - -RST isn't difficult - a lot of the information in here is just written in plain text, and the parts that aren't provide examples of how to use it - but if you'd like to read more on how to write in RST, I'd recommend the `Sphinx guide`_ on RST, since that engine is responsible for building this documentation. - -One particular place where I'd love some help with these docs is the :doc:`custom_fields` page. I'd like to add as many examples of the -Fields parameter as possible to this page, so that in the future, users can find working examples for specific fields and field types. - -.. _ReStructured Text: http://docutils.sourceforge.net/rst.html -.. _Sphinx guide: http://www.sphinx-doc.org/en/1.4.9/rest.html diff --git a/docs/creating_issues.rst b/docs/creating_issues.rst deleted file mode 100644 index ae74b69a..00000000 --- a/docs/creating_issues.rst +++ /dev/null @@ -1,58 +0,0 @@ -=============== -Creating Issues -=============== - -In order to create a new issue in JIRA, you need to provide a certain amount of information about the issue. In the Web interface, you encounter this all the time when you hit the "Create Issue" button: - -.. image:: img/jira-screen-createIssue.png - :alt: The "Create issue" screen in JIRA shows information needed in order to create an issue in JIRA. - :width: 406 - -To create an issue using JiraPS, you need to provide this information as well. Before you can provide the needed information to create an issue, though, you'll need to know what information your JIRA instance requires! This can be dramatically different from one JIRA instance to the next, and even from one project to another. - -Identifying "Create" Metadata -============================= - -JiraPS includes a command to make discovering this metadata as simple as possible. You will need to provide both a project and an issue type to this function, because each project and issue type can be configured to accept or require different fields when creating issues. - -.. code-block:: powershell - - Get-JiraIssueCreateMetadata -Project TEST -IssueType Task - -There are quite a lot of fields that we can provide when we create a new issue! - -This function returns any fields that we can provide when creating a new issue. Not all of these fields are required, though. We can use PowerShell's Where-Object cmdlet to filter for only the required fields: - -.. code-block:: powershell - - Get-JiraIssueCreateMetadata -Project TEST -IssueType Task | ? {$_.Required -eq $true} - -Creating An Issue -================= - -Now that we know what fields we need to provide our JIRA instance, let's create an issue! - -.. code-block:: powershell - - New-JiraIssue -Project TEST -IssueType Task -Reporter 'powershell' -Summary 'Test issue from PowerShell' -Credential $myJiraCreds - -This might be all the information we would need to pass New-JiraIssue to create a new JIRA issue. We can do much more, though: - -.. code-block:: powershell - - New-JiraIssue -Project TEST -IssueType Task -Reporter 'powershell' -Summary 'Test issue from PowerShell' -Description "This is a sample issue created by $env:USERNAME on $env:COMPUTERNAME." -Labels 'Test','Fake' -Credential $myJiraCreds - -.. note:: You don't need to pass your credentials to JIRA every time you run New-JiraIssue. See the :doc:`authentication` page for details. - -Additional Fields -================= - -In most JIRA instances, the default fields are not the only fields necessary when creating an issue. Most organizations have additional information they track in JIRA through the use of custom issue fields. - -New-JiraIssue provides the -Fields parameter for working with these custom fields: - -.. code-block:: powershell - - New-JiraIssue -Fields @{'customfield_10001'='foo'} # Other New-JiraIssue parameters - -For more information on the -Fields parameter, see the :doc:`custom_fields` page. diff --git a/docs/custom_fields.rst b/docs/custom_fields.rst deleted file mode 100644 index 0f5b9a83..00000000 --- a/docs/custom_fields.rst +++ /dev/null @@ -1,91 +0,0 @@ -=================== -Working With Fields -=================== - -Many of JiraPS's functions contain convenience parameters for issue fields that are commonly used. These parameters take care of translating PowerShell to the correct JSON format when working with JIRA'S API. - -However, not every standard JIRA field is implemented via a parameter, and most JIRA instances also contain custom fields to allow your organization to tailor its JIRA instance to your own requirements. To allow JiraPS to work with fields that do not have named parameters, these functions support a generic -Fields parameter. - -Using -Fields -============= - -Basically, -Fields uses a hashtable that looks something like this: - -.. code-block:: PowerShell - - $fields = @{ - fieldName = @{ - value = 'New Value' - } - fieldID = @{ - id = 'ID of new value or item' - } - } - - Set-JiraIssue -Fields $fields - -This isn't a super easy syntax - and the module authors are always open to ideas for ways to improve this. - -One of the best ways you can get information about the type of data to pass is using the Get-JiraField function. This can tell you a lot about what to pass in the Fields hashtable. - -Specific Fields -=============== - -Here are some notes on specific fields that have come up in the past. - -Components ----------- - -JIRA expects the Components field to be an array, even if you're only defining one component. Use this syntax: - -.. code-block:: PowerShell - - $fields = @{ - # Note that this is an array! - components = @( - @{ - name = 'Component 1' - }, - @{ - name = 'Component 2' - } - ) - } - -Here's a shorthand version when only using one component: - -.. code-block:: PowerShell - - $fields = @{ - components = @(@{ - name = 'Component 1' - }) - } - -Custom Fields -============= - -Here are some more general notes about types of custom fields you may run into. - -Fields with allowed values --------------------------- - -(Also known as multiselect or drop-down fields.) - -Use Get-JiraField and look for the AllowedValues property. This will give you both an ID and a value for each "item" your field is allowed to be. - -Then, use this syntax: - -.. code-block:: PowerShell - - $fields = @{ - 'customfield_10001' = @{ - id = '10029' - } - # Or reference the value instead - 'customfield_10002' = @{ - value = 'Value 1' - } - } - -If you run into any additional fields that you'd like to see documented, feel free to let me know in a GitHub issue - or submit a PR to this page with the field! diff --git a/docs/getting_started.rst b/docs/getting_started.rst deleted file mode 100644 index a736183b..00000000 --- a/docs/getting_started.rst +++ /dev/null @@ -1,41 +0,0 @@ -=============== -Getting Started -=============== - -Prerequisites -------------- - -There are only two pre-requisites for JiraPS: - -1. A working JIRA environment -2. PowerShell 3.0 or greater - -You do *not* need to be a JIRA administrator to use JiraPS, though of course you won't be able to perform admin-only tasks if you don't have those permissions. - -Installing ----------- - -If you have PowerShell 5.0 (or the PackageManagement module), you can install JiraPS easily with a single line. - -.. code-block:: powershell - - Install-Module JiraPS - -If you don't have PowerShell 5, consider updating! It's pretty quick and easy, and there are a fair amount of new features. - -If updating isn't an option, consider installing PackageManagement on PowerShell 3 or 4 (you can do so from the `PowerShell gallery`_ using the "Get PowerShellGet for PS 3 & 4" button). - -First-Time Setup ----------------- - -Before using JiraPS, you'll need to define the URL of the JIRA server you'll be using. You can do this with just one line of PowerShell: - -.. code-block:: powershell - - Set-JiraConfigServer -Server 'https://my.jira.server.com:8080' - -That's it! You should only need to do that once (it saves a config.xml file to the same location where the JiraPS module is saved). - -.. note:: If you installed JiraPS to Program Files, you may need to run the above command in an elevated PowerShell session. Otherwise, you might get an Access Denied error. - -.. _PowerShell gallery: http://www.powershellgallery.com/ diff --git a/docs/img/jira-screen-createIssue.png b/docs/img/jira-screen-createIssue.png deleted file mode 100644 index cbf5352f6027e73e11efc933e2bafe9c99b37126..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 41594 zcmd42c{H0{_dl$6?@qMb)s~i`t(oAa#wt3Ql~O~DsgkOp)I0>~q^hWz60@3W7PA^6 zEfpe2%{8V)OfeK8h$Qc&?fpE@`hI_Fy=(o}^RD&&VY#l8b6sbjbN1fnvp;)Z5qAu= zPq6Z^vaqn6(ABwR!oqS81pK`}dKhRqmUmJR_;$k77uvEmb z?b#pN@AFv4(wl{ay>#8h$*jl4hK!FeXO_Tk|Q`XnL0nI-JTcm1c=Dp=G7 z=9+FDFcUldk>gcRMbSr%ZH+wvX7XMYbM4|t>NXR%aM@{Qsx9)xUpJ0keDPPMbaKGP z?VQy4H`$Gy0!w3cM$)zoLXnY?>p0QOj^{@>_B#PR9VfCIaa~-)%v2ug3=4|z|d>=o~j#mxgP#G-i@P{g!!@?_P_hQ zkUP!wt6k^e&3`p2{(sl_R=T^T<(XrZrNi@>w|>wE53pyQf|>%OTWhq4N5aDPr<#k; zR^o@#$q>8;oMuf}cu_4!U73jYpA5{G$_s1xDQ;g_FJ|q1$=eG#?Wz3!cKt(~tZe&J z(&2u&tXj$M-2Ne_{O1Du*ne#nB%l2C>rrPhH)8DO(O=`dkUw3!+7XnS!-hxi=&B4c zbFZ!^+AS@{XXpG3Tix8=4aNBi8?s;XuN!TclS12m9Nv)FFMD^Jh;;ni9nKA#J zeuAzLr>yt(v$?A;l>4*7NEtSv-;Ec{c$d(Sz#F?U(YTqJT!S}gF(b7G+}F48fYreI zxxldt-gaAym-2?%U_l#MKV=n~m#+&!B6lP=;_9R!%5I5g(w+Lf`adw5K{oZ5*r@4s zf}ahvxey}`G3TJ9@96lpPY^vj5vqEL;w+35(Hl5i{qENu>QFy3ws$aLfkt!G|Qv3DbcIi-?A&V{tt)O9W;ZeXv@Dn4`|+rTEN+L?dXHWH~xT&7pb z%DebspSNF9GMndACVEKR{ITHzFg@&SDY+!O%HPY*a7#lXb$|)OtmmFjtwC-y8#Hex zTy@Fhs9LZO^jb~o3Od724qNYNo&D}~C6zzaAS1}LlG1$@Q>WbBb1J9D+ckJRQ@iL4 zVvi&{LYryDPWSgq4&e#GLk>T9KF-p|WL}$0W)6gtLfXC_e2{Us+5-EUAiJ+kS5z2v ztL}P1G5)e^Jr`B1T{-YgqZ#B7aE9OM(;~7o-ZuOAtF`{7hDL^+ zNfM`GC`Gg&@S_A({acLOtEIgDt2ygFYvaideas}^l`b}9>CS_}YHpG)`a5GL5*s`> zS9-!KnZF6e1w zF+p68f3DT#T*AKP=l1sxY)y1mFL@@!O@tfag6)j(_`Sl`%0^`=k#NF9X;X-7;5nEH z^N+97Z{g_lx&>UHOwnq0XTc`hV#Xw@P3!_%_DCD=wW*yImF@mU5435eXrsk7jZvAL1AF%yT3I7^UIft} zVBD8(;+l7#S(==$-+QJ$M=GxL@7sJq=0dsmk7-zrzsdwOihq(~7Wlo=L0zzFeM&Is zuk(*fQfr#aZno@=LuvxfAasjw8C;p|KS=gritKa>!bsI?tyyb3!DkS7nX|(4#jpvo zx<~VmVfv4&`{rMw5bZ&nNZirScbw_4S1A`2F>Xv)QngQagy=CSPwyv3V7G8tg6%V( zM1Uh^shzc#OOeIgyA&r-UB!z|R&*{#|2*it0WYR*;aCyUYQDbTjV>(2pNZ?cwdU!sh=JwX( z9hq4CR9*Rib@T9as>1t;RI{=7J?%=g?5icU3rm0mE{z|C9mYltMdD*0jnxLue*5%1 zqi(GeD+zLWl3;Wf58{2;Ganrg0;hX5d`I*5_*M0W_ZgQZ*ba}{hQ5##^Cm*IS$j)e@*)whtW5w--=<-K5ul>w3*dj!kP3p zlAt3LEQ5y?FW7F=E;y=*z2b&XcQAr$P7npX+=e`P(_w*u@U5m4CxbV9UnPyy9%OQu zi(#|(qg(GV zYM@QzYRd5D_&H2~w4IWSgVAVs>n6UU0xw7WD6^TK*XCi_yHMT|hm1E`5dE;@4em4w zwy03-B1B?0tNJ6SN&ckw(YSHucJ?Fc(Q zHnvJ`ReeVtZjw>tsq>YFB;ZR@hGN6=?uWSMMYNcB@A%H9n~ps%Bd>Hr5ETyeS(R(4 z8D+a_o?1x6gU;86;b#y>wq=8ygy`~_kIMaQ|7Y(^Ut(*8BLlP*=!maeSzJlsGNBdKV5u=Yx=CZ zcVHs%DB6Cq__YxxO`c~58hD)FJD%|5o+%`(D zHZ1VE#W67D;NhdbQR%PZqha3o(NrT`b2V&HV`TD^!M=@bVS&^6wn_!c)O=CI58R`$ zU4dP-=KZ$S&f^g@I$7(ylna|X49^M6+tsBy3_a?WGj3X?8tGwDFx5+)G{xFt{z1%f zjYr+yMze#p{jD4V1?#v9bv9s%jdNx(1oi90fM)%%QZ0MfS5NjxS-P>x1Nar|)V{zl z&AboDR{rBNR*@&W25#g__YDOMHdWKxUb;_~drN zpK2Z>$2MkJ#58(|1iG0K)V^LczG&%e-Y12JE9s%5Nz}slT?S9Ok*(97Vz!sZ7d11- zF7JDKBm)T5OwFT>dJ9v&*<{oSKG?{%k61Y;w2YInJH=5cTD&xkc;E(K7_R>}FEeU3Lnw z0(M=bn6W+zSYcuPUS}YrWUT^=j2Y1;&CfB81=?5AF>hBoTCy?5yVGBnM2m>KFtL1X zj*h!n7UN-!-DjJDqvn8mouMPwqN816Fp+)M&GsJ0A3E#|5qVV9B#uyse=mgG$_T!} zG}fQ9J6!y&0NV6!)|bJD&{{=VNw7t}o_MCDCIZto;w9)VtTrn9ttwo}+EYJb&yZc@nhbJwaaiD)lQ7kRc1Pt$psWBx%Lk-qHuKABMf%3E+sKSX+) zmZ2fq3M&b`A5OYass_3krS4cnWtm&3z079??rMUEnr^A@yt?XEb2Ud+eJi0UAgI=h zL$kEy{^w2P91L?QMtw6|yRn9G?+saIfJ|6Z)M&2Tvx$Wvmo@Zq^$bVuxl7FgxUHHeqc(q=@p}X!k7&r4Bl>eQ@N_ZEfyf zQ3j`tRYgeMV;4wa`T6E=DnOb5Vs2J>i1v`+?+~Q#&i@;J zfAK3KxWS{Rn3@QqZr=iN+E4--y-2U;s%w7#*cWCA2EPR&2<=eX7%|9DG&ivqO4{8d zdy$8v2n(*qen%eqIr@>4{n>S!N1dH08Hs)gXZX;;zhj4sLJ7ZcIw0i@-hVY#|JNE* z@Bb5kz5N?22E@WFEMN5W_4QrZ!}i17Yt{j0{=#IH@3%i>L;W$Obee1b`q6i@YkMzS z{s1oDNj0&)BHjV-H&=&Q99RRy1TLS{{*bs3dei;@aQ%hL?$GCCq+JkhBgpC3AfqkC zPrmj-+ujWOsQ&wvK55WAJLmrx&dhu%pxfx*FY);I)7vNh?o)OYPd}EcFQ)rxS7GAVvxK_?su$M?j3wr{;qg|*kWS-WD|{#hDIM` zY2XbzWE<^ytVDx;Wp8hT5S`t-h-$(f`1Sg;$d9}Is8+2`?aPqB=!4g&IpyyhY#7sU zcRI>5O8*{xVK_^gd-*8JlVv{iG}nvC<;-Rwjxt*X)<{N?jMD4<_coRXZ;d!fF*{w) zvor{V9m=An=IGXMal;>+=AxTH+)Z<)*C&kBV+W21bSRLmf z7QK4k{Fpq*G7;1A><4X%tv)fhM+~%E+&o^Og(cwyLdBS~rFBJGNNzQbC$nF}G~q=S z#hCTqPdt_Ybxy_Y5RJT7J2x@oB2+>~Y$_~6QCg{J^26TNCb{i?<#Z-PchbtH`u(dl zCMGFa+;DiKEJoGKX=K+!dy%r)ZuNVTt7?POWfU$97;KqL}wU~&V zwqhhw`S&*naRLVdt=zZ+PD40?E%Fd@-{F@aC&Vj|tRjBK!Hw*oRs1JsZvtM=P!6ZQ(V$~GRd`OE?-psabt=RE zp$Ql3ko+TO^SImL2Y#RcLx)g8e{8`P>+(DeY%VGldfMCjIZ zyOE}lYgn(K{tv-2E$oB|`9Y;|@0_vR_M~@I#1gV1UNxGw8uCCdif7s`KZl!-yfoTs z;!RH^l|-$0$rQ(KTDV7dZY}4K@KvRS<)&l$xn--%iE|Uf!(t#8VWlCnh;K_=%{m5G$DbUG?6WtwgryZf1N+*09U-+gs11ExK zNML|@ca{oUWQLMN1SPEjZ30eMa5T82TfE)zESF|>@mxiIF|^Qk(MYC%ZE%=?a+zND zK-npDw!;HFP5hX+bM=koms{zy z72^2yT#muT#L^*Ot&6?LLGz}1?oag<5GQ(cbfB4z$&gP?iE)kLn6~esLI|i#VB*r4 zmiLe_QUQn%GfD|jdbJ-S^IoQeX-YkE3#SY<-!#pFgkxwEt3}x2>b-ewjrFu)zJC-* z2zBF~p02du^NOSfyJ3#v;I5>*C%nZYG~?u^$Mxg%^&yUTx^gt6{PZ--}*(ete>KK47LLgLwt`M}Lb zjQ*$%-L-F%KhUA3wQjspaB1^=$9GOhOB2eT^%h>U>cj_m3$VGjD0CPhwHSoXa!=%# zyPGwvo0wa)?+=4m|4YmHY;Z~M-yAJ;g=!x#-&xayZG4ZW@Zf0#uJjM{>MA!apXL2=|%S+ zFpm!&qYZbrj7E-Fs!$P02*T3(SLNZ25z!Q+`&|z@8VN0~VrZ=uu4Vn{%c{RQ*9P50 z*ktm=4}4@F8803RDV9)JNtfPa#iz$t-Yg~KiY~w7pZ!Gz3#o`H}sZ4FCMpD?(jg zzoBX_x>=%qZ4KYBcd*kV%u_QewtVEx!7d&j>fV(PfSC$s5ULJZ#~#A$#pB}#wlX?f zzbu|XRL&gbQT>dtOU4u^PuYK{4t1iT~WP1$%(50$O=k9{Nthk~h4&jVMg}HbUmeZB>?0NC) zNXG{{nF$&>bMo)`(%cy`EnkbG_30JZ-SWR}ukkasir10MseI0{y&z5F-r)u3ApV?h z@|zV{;Eg`?iVw5C#a^y1*J|BECY3?Xn^R9H?!IZQUakgy6nF0FG+)=&y>qCTJq3A7 z@W3*U#zOPfZYuc;Sy>!zDZMf*N`jbr1KJzHt{=S#(YKdX2VGNp?}VM%<)bkMd29s| z`BJaG)<(BvM_R76{`Kt$fU(NCfHSCYq$OKfqez)2{#I#>f?tT6Cnz>9xv$H`lGIO& zKZmpA6V|W~N%LAxEGZuP;KTUd0Y?YwFg68F;4nMf;Ups_P2g-VQ>lzb(2(k}Smw}1 ztd0Kg4PEjeh>SFB6xe`z$|Z)i{VfGtOPKT1>?&3%V*VvDf{Gez_|jivgPGUctOQ(b z05?5Ih6=bgh1@fUGJ0U{g2JpE=!WZoNr4LHuc=UA?Dje<(MecoW2vG2_q#1A`H*l) zNlC3w4>v7->g7mYYw_EG$PjB*Hc&%31s_mz%3|m`+H+^wb+}7zy~}e)>4?$kNL|_8 zE94-xRcsa;ep+sJr`_1ffXRpWvReN|V4`Va_wAqCP;P|Z@6G3`?&*6Wbm4G)ql#!f_{e>G)D`v>9%NxJXB?+;&%L3SdgXp6aD{X_5Yh&AM{wA2Y#^FBKoP`(S^OP zuCB8vXZq;jUyGVD`7V$;;ZN!}(x@pr@RvND@uQ6!a+c{aI80_0I&bE6Pa*Ey|MiN+_V3=6H$2h9-)+}@a9)Y zFhI)Y`>w$L6McVar1v9dKGhU!+4n*=Nm~25;KYp}sMAVF5Z=IOZiJUyx}jdSj7YD} ztxH#W)pdpX<edS? z$5dP7!S865Oi1WozRB4?-2M`Zm~Lgc;3Edgibon;y|nh0UL>RH*o=dT@{bY?4x521 zX|UYuY9gr#L7yDlmmRI;i%7r#`4pwVF>tUaI{Qr9)#((Xr$lMbfb^H>ttpS zcS^<5CMotJdHt2j^O?Tc34 za=dNeYDGd<@-Pd_jb|;KS5{goFV!2E>}K!QJ>C8LWv-)_c0o(qZHV@Di8buLDU<6ob+ z5oZ*-&A{%_xHprfmCUJ1-$Q?e*0AEOJ&lZv zb4B{RXFbldMarc|=?bZoy4>NjgMlf&JwyZP+nx8|R$b2}yL=-)4;+4BXF+Q|ELuwR zE3>y<1nb*Z;9tLIdO#q^#&S?*tW!|B@H8T7dERUzO@0oS=jginB&|Y(s8X*VRChj+ zj1|_lulF_ab03vBc(-)K|KOjR7`B}|t9`mW(_<s#M?9#qTyafpG*kRqdR=G`>-vA6B(aHog*r{c<2U8Tq-+Ja%40xKkt(3L@e`nElB zp3~3CP1~7YjftR7q5Fa4pJ=}0J+gV=Y?l-{=$-d~B|+$UxudX9ZoTCEdT1!mAJ4GEGPre zca*`C3zyw(-Y(>Ns|4AOhg&8LdE5ph0w4p&MqfD0*-y66%-m;j9R$M1;WH9?=Q5E` z)5jc()%S{(2~sNc-tmFTU*8-!rxs}IKBE1?GOX=tAiOcEY;A{S=y@n#Sy|ao_rO4c zv3b*bGkuclIPLA<@oJC2X-CROyKc5{#(npwWVu#w2YjR57HklI90T+VLp>E(&EpMH@ z0Na(@08gGAfW}H1Huy`Fbi{?oMc%d7ireKDPV?bl$+~HOjBmBYBrZO-`IV4JQ|O`j zG;>R^*Fv+2>=)9dxYH==Mne(6_n**^b~elCQj@Cf^c7bXa{Ilt?Uq*6F8jh+*juLa zyv=CGM{2qISZmsg<8)oDW0tNK=3g;tz({MGt&P~*aQLtTG!UiVXpECE9MIOzW4&aO zJtciPxI~ua1$UURPbZtcy@=%%OIwKDSqt9X*?f<|lm{~Hj2!2%HeFo=-*Eb6hV*ri zic}=Fn=LNWP_HCbBh9?Dya3uIw26H}+kRYCev8vN`LYF8xlmp4YO#A(DPTYktIOxV z=H;0KN`*&}Q(jhwHIf3RfT0+x`!pFsOFsJQ&RL3C1h z={W)GtG1!E2g7;n8ey7qMn`0V>{bnIS6VI=d#TmjR3yjsHCooL@+2;`mYU^NEvB#WywHU7jEQ-r4zjA0O51x?YuuKhoXD zxgda8IMnW0U7L3(nO~7wax0r8;CYm40G!65ZHdlRx~$q0b)n&O-aAp1!IH z4eg}+KznLP=Efz?=r-u%hv1jt;f{avOWLB~S<}5vEG*xz*{-T?xr+**h1Y?u?A#pnIp;zi0`BGR}jsh^u%0bp) zk2K%>y`)_LcHGJSz+cCI0>uBp7#gYXd=@)f%J_%$`$aMSpL)h$O<*ns0ISmbuy{9THU7zU$64cesC2=DYxD3-q}5(D)}+{(|ejdTYDf`K+U&Za>x4 zSJ=Bs`uY`EG^^bs<8_SdGhs^Vh))*l>l1MB1t5{2bHow8i&&d1CAMzDRPvw>0N`}Z z>j}9Sei^^M(zx20pBd_63y}C%J^_l}MIi9zk=i{%+-)PHU$s0d%L5?W@^N4Xp7i7r zTQN$0sV$YC01RK_W8d4Dc!1^FTwi#&F<4O%!2kP`eA1(Be<17--}Jfw)0+&B-e=yw z?1+Khm0zH^GbzG>kC%&#!4!*-`jh(@{|Z1i@3Yb#Z$wC=kiF#p{S%QJ(os6&{TtEl zXCCH*PjlS?{}q%uJDEs^*WX^rR1;L9UVUWa{^!30$P<+6?CN+&(H7*4D7fVicQ)m1 zy|Am?&oJZXn20xb-;R7w`W)9^S#DBZW|iPp1iADRVO{&T$UbQ$$2Bj>CDcfBB@c5D z5RBC{(aZ>ap^VrjPhF!J06J;Kg%~@?-1d2F;}uyY$5|&$6^8buS+1#KI`j;?$2<%# zzo&`{$6HstUnHHt1&CZUR-=EbwmJV=2Lvr?g6fJKp$Vg3HeUzAo_8C@;A{2^%7M7g zgIM~fYR8QsegtduX)d$VoYR%>xGUrYZ_0)|w7h|hmP9x{5EF@=sZOGP^Je7fs+^6$ zeTnjova-L9J+-@a&QiYYZzMNwig6vNPD zDlIml#_47zhEw2t9L2{F(dCx~&@QGBu}=0vsEWtmIjpz(H!O<$nX|sKx|Y#UXRkZE z!<8`2|5&2(mdW^t(*S4xdV+C}tU;Grx5w&-%2NT%U)>50tmPcvt6R&?Nw% zXvy``9nWnFQDdn%Kn_$sdUeTK3!pQiz0a4r$Q*abhJ5J6y&GhcuJU6}F!DYcVw1^pN zWQxB?;cO%Ywe$GzXdq8^Z7!$$NlRY@>nxCfZeNNy@kVc-K)L_ac)ck1tHAa10Rd@B|3cc6ss;+oF$Ql{+@UpIUh2_um+Rxo$YtcL-uu)!H zlk;zjx5Fyrxrs48Q)DJkQGZqw8O4c71q12lmS_ z-?{EPsb5yLZ`Zm}q4#WoWM8@tb3L}Dvf`Jup9>b2k(4aG5-kAK$?9Ul;T}thVbJIM z-ejT0OSuZM%3 zCbWx&%~K9eqirzx4%6BD2{3`jK}J8TEU#QnIP)vZ_+2@y!Gnr*ABp2x-^t@b$8F139-TeY3)LUMBm@!3&0?Gvz@zE}hHlb^6-0QP< z;o|Wz?uaTT3e};(*b%^6CMxmoR5mqlz~h%XBE3YF@@Hu_gh!J{fz^NZ$N=zvp+$Gb z_0*kyr|8h0h4{`*CA;`j5T;<@2AOHX@Jv;OJDyHfV)k2*rg|~)1P#f8&Ku4LST2aU zIXr85wk5frdD~=)1gF3(%9td@diYk<`1nS(XT9+zmei7{zs><)50Bfa(nwH}?CiwI zmuYM|K>#7YLwNeD3R{OVfc^gK&sy2*_6w|l+X8&;hf|3RM=dY%u9FUzaQv%|J3|d; z%dMtOR>cFS$KaBffEheCsjQd3;$r`j$ZmWmBZGfL z;L8RQsHRd|WHeRX#11i@u(13H+n;&EGfVJz-n(*nQD-x*`z|*=HAn|clDQJBrq?$J zp)x4OU}gZ~wCb)6qL8_bnyJy45c1d?L6WLF>p#1@9#imnXfNJh*$$k}8(*=1hUG~P zh#dlmf{5ez5?^C;uQ=T;-GR}Ar}m@f`>D9jJ3`We{m$p2Qu=A*u!rMyM%^9R3b-cv z+bAc_S<3Tsf!!5zq8Yf^9WL=V=RV=dT?=v3Kx^vTVtB~ zfs>>q=NMDOjuGaMGs$<5kkI?7jv2eIfzYuB-WO{=C~f_d>ry*|PKCDjM!vaJE>T}` zV5C`hwQc^N$ouwXHvDDnyOrK#5%1kM2{v`2u+u534yv6iFa;%%gJVkis0!p~^d1l3 z7M}cdkN4DRMA?^z_Qo5+*>O6A2v0p-d*k=FOtv&R(UPIA?A+rq zZns*Id{WJll})ZphJ#=Qd)zg~+drrvDY>h8;6M%&!_8v3x}cf8`( zY6p%FUFplzv>f904eUi`5{inlXG|(<{IB(#JvBHk>aV+s$nl!^;K&s>$p>5{h2lRf zBXVX$-}HWQU21iG!$l2PU%p!?dpa;C3ut^vKs!(Qg=`k1d1+1unY zZIX#upJqNvH3+81MD=-*9vdKJ@*LMa7|)y5KAQ(lYiPIuY2>-Oy(uyT(Z5LUEro+d zka1q5_VCiYfp6nqF+d8c;D%Rk{aryNiLoHRWMNH0BNTI5Rr6f&TV;N&9sYz}7dmzVYO@g0prSeXxkY3Vm00l+28<=yAw3>eG7u1$t3>E7n@1_*%h~P!SD(bD}}rlUfiOwcjo5Uo`q&* zKUOxA0ku|1fk3{)S@bZHKZcfWg9+AUFeK4(yQ@k#NjP_WUCfD&K@0Yd80Iv_{LmBu zO1%reNDSOF-kB6&5=k8bbfZcdhN*$4@{dSF3QSfaOr8S-iq-G*(VK2`U)91n@?RAS zT!_JvtC&I1jlv3X-0X^udx9EZ4LzR}MZ`e1pKQU^XK?IoQ5(jUTb5+Y5cNp%+cG(R zXjbygmd>Hp8u#v!RvuGcWSz$xG%(Q8ke>nDVIY{6a;TUN_zGN4ntt=f1FbEb{#acH zF$9ikTHDC+3f#5~oQ3aUfU4Oa1k-`x@McG;JRtL$-lzIEG$TIS*2isWSXHRxhM@_N zc$(7alVhxoc&3*r|z<<#b7h>8G??4t*MxmCL`&D3~P(52WHXl+5!1;(p= z#QN~`%V#tB@tlz-@FkujAhy_BR$Mj39@qU+ zfxMX0Z-hAc$!I-ZW5~_UICplViY#5O?cqx#7QOhoV(6u zW%+&`4{Q$yDdM)C%8Juw?#%(kkwB4#t$=HAhz}A-!m0H&28N$UKQt<}04G=%<+}L? z&#Wa>Jyael_OEgyDoBh(YC~OPBrJM1H~u}Tk6AU)i^q$i@x;AZrOJ}StFEg2iIC3> z(@N3!N(x>8Ke5s3wK}E0{wWy~@9IEA_!~08p%fG|tZA(;W~L`yRbd~ZKRmLp08d-7 z;vniO5oulLj>8*ihzw(?IC^6p^ug4boyUveTAn-e%L1J!!g1V~Mxbspt%jLDqp?>G zHs1$?e}?b7lW*motdY`ut7vLQQ_42NM%DLL89MY%4}E4VE_6k_UY-XT*`ARoIZce8 zV@@k3GxPCKXxKh%e7t`?{wzLXx#l#DKEI#FzzPG%Fq-Oh2dHg2iv$3);w1jM{dJ4R z$KRiAY5me0d2Yz*oRP=cC6NZ#}HaA0KJT@0NC~SF4`J^ zl9XQUA%(960JhqX{E0pDvU>YftUa$nSKpUh+XuY=wXppiO{zyn;$-|op-Ztkrn{U# z@&W`t#qD@C_wav_pp03d0L-M0Ctmb)0>LqjY)N|e{6y% zA^*`o@8Gth{Lu6uVWFXvm*rj#fM4+>M;#GPi!%al8K2 zaYICCI8c(RBxB7RJe_=fT8ZAg4eg}k2=)7HV}Z^n ze9jr+G{B>5rml`N(yKI5I~;;pJ6R!+VciXdNw-cnpD$8J8J>xmm=v>1SjY+`tGv>^ z?`UqmI1ZuvniAo2T>ho25$2nL8&-8Z!?3H^hUsgrGqeXX9_#NY3$$fbvG{t+a}ne* z%{-aJnxWEBYU{MhAWSrROm$_rW-@mEUDTZ3bRX0E5X-ekfST0{C!aUv)d_hnCnqae zKb3V)vE3s9DFVGihX-FL+bz4MI!c0|TRJybI8|ZI%;b~qhIHU`;F-DJyEkf9 zua~wvyC)zM&y)^PbBET8O08?iYRwqm_UqkqtCaMM{@;74gu<!#TXy(q@I?h3K)f{b{__ zZ)jcYi9^~r!WCe>M+mDZ zC^)8K(R=D!s9m}Qf8!=RBy%mnk=uOWaOK@ZTJesu>luUuG2RMaT%H>LDq}4Kr2b{yw~RqA*!&>1 zvN^P&Ag^AeX2HTTuruC}6Gyq-1?WS8!u=BIBjF4^jG zP!+nzis_^)pu_Vzskxu#N`oi#I`U^mp9#C=Q6Nh*b#O;^kUmx5Zyt`cs_D*B|u+MAk>bZ53s?Wh%2G`Wz?ebXiR z9S%;v0~Ym;AFnsxRW|+Z)o@so@~VZDk-*S=LuRF?rGsrT{I?>kSZw)&FL5p#>4`WA zL}e>oqm{IpugeAAVG{Q~zmF(kypSa;kyoOtE5|G?&Pkv$&zbP%^(03@6V>UGJi~Bq ztV(zNb?Zm1cN~RNL2mtmYK6e*Brw#-N<`l%f2YP~KX0&Jql2C{ZGKF*wX6C1L1BEqvQ$kS>8 z2BE9?Kc0B+VqdsJFHo>6nfvUkvEpeNvcDZYz6V*}afTgwn4fs=+-u8B_6Ob`KT4A) zJEBw+4Xq2)@$9h(xDgO?7T*Cs@ssU2@Jg?RUOa8?c3!6N(trnpYiygB7Z(*k??a0( z+xUU^8JYhQQ4P>4p3dzNy1d@uxDYpQ2npl zXJyzAf3m!*TC-#SRXXy2B0u&Y-Iwvn2`CiWwtc{FrsL#JBZj7`;5)v#e zFI)O_StBbyIMN~BkQI@My|3l&A|fJ=!)3O8M50Wgsh%BdSz+20#1#*Gj5}6YUVg9p z81NjB<(3Oe&b|ka-yYf+oiZPaqy|G z69KRs$&8&uve#sit1vRw5nde-QmrALJpNj?yIfv!;gfmQK4BpH2?RQFS1|5X za$O8o+p#v_u9_M^E4b{03{gIL;-q>yb;cXUkqNrq3I_X$dp@dyyg1udYXwqC_R?BG zO<5bwTf=ob$)kWvcQqo?lg^YvvBrnV5vYH8{y!D)ZEu4JL zs|;mTcgvL1nbyn&z2a=Bq=y4&A5H27%b18D|q?>okd=FOoy2YZ83-Fo`Q2x|`e97@JhsPH7XyPfawmN$`kY zGw8^WFCWW=aiGE?i(2$q2r6*o!O|n$ju(R(i(FhBI|eqF)}m7GChO~hr7&`F2x zKg2c^BuorB1o`QlVV_GU98V-#K&-s5f9l&?#l>DvmghG@(*PP%rJ-crh}j3TNXaw$ zJS_T+&^>affxoIe!GluPnNH5B%<(U72pw#YJ`2=_S4x>}Eml>d%1zZ7=3X+GL@JQ> zcw%_X{@Af;M_Ofcuy>5k!VK*&tG>OiSJkOFetv{ww$c6F$CAZ=f^M^4VSSovcHul8 z$eX`eXedwMD@&9DGQ_nmj82N~Xuy-r6@Z{;Quxn=^zD6meuSJ+Y!YerMm^UcW(144 z8*(scb1HPCl2l-$B)t$lO_%fY%6Bv2#i0oX5uT>~E{52{wYezBtr#!fO~?PYb0Q;iO#Sq-_AU$<-)&(pvt4 zLx#UqXr?N*L;NbdAB9n;#bM15iKRh+bQ)IbkE@o@NVwL zUekG;e+AeV20^SIhlK&=Kksb>l)Px>@T;L12h3xnC3h9Ta3lRv;x@#Tw`9z5Kw>dy zIsngz#J-#^sxU6$@c3CXjm4sx_kzvM4tF=*CJfQNdXv7tF*xCtIBDy2RWbN>5Qlz+ zGPn)}0@V%B-QxIihD%9cJYSOBsuD7;6n)SO+Yqk`a9kc00rm9)aCH03KBd(Q%kDZ- zFzD;3*5Gno%wo_3by2jc7O6qDw+Z0HCS$5i z9Eh0p)%sLRa5JS;i8R&cwCJ?M7fAk*bk!7ec9w#o|FBr}x^8aa%xQv8`_AW4a*Dknd_1hcLdYUQ!~)X-w?AOtX~Zy5vs` zw&j<59feRr>_ktmCX?+^7M}Ij9{=<=$D>*?Qzo9FJAJvwxs;Y%xe+ZsCYR{bLx(Xq zWl^m3f#~y`vq>KiE%)~z@PKQB#Lqy2!D=_>^``y3hNyw;e6rDje$89VPaQ!%2m0o! z2h4%bbn`94KB)+y1QMl+&f566ADGpGS`(y;LGxpj&L`e4N%56c%4n0DVVcC%+TQh6 zMT>mLk9O{U7>ZkkzKL2{JA^7b=v& zjj073PLaa-(B6QXX09k!Gms*v3OM~(^%p7>V*nMF_sVXnD*0MyVMWOgTi9_at~n5* zkL9n+SHVAb-szH#iFQyUvdgN5Z!l{+Ny-W);HYS?O=jm;*mHLrE`95w$w9fG^@j1H zUDwU^b_i28&=O&@l^dnbY&yO)E@Hiz^{^Qz5Fdk~VoKNRDR;pVaM^c z>1xya<4h$fBeXPR)c@0!Kf7jadQJqcS!*DBQx`Es30Ent{xd_oC>(@oV>HmeR2i?d zHE=fk`Le21j>qI%>qAvdXJO6*n~4<&wqI*Cl)iHk`+Rm}{!EvKkaI?GW~R=oHQ7%? zh|nF<8K4v~6)9-EAYg!Bikd8rOK_&uJ(eU1xQ=Ibf!lTK8p_4WV(#oyNe-bl$tJ4| z2?5DFk?J0rnIK5CtvN-TYYcv^PkpA?+_^XWd1-06DL?0I8fvGdPZFr$cb2yS^L!P9 z{8N)2!svSMRJ3%_(&2Xj(fx#f3W(Cl7Ww4^^&z6%i08w4OsWM~J${J;g79d{%7~oS zP$D?>!fYw_4|ZKg>}@k~E{vB=p?lSV?A^r0o1aTsOgsfx%GCkjb;S;Sv(6{E7pj?g zXBBkO&$)2R-(u-zw@a}d*gXGmuD@&ND1M=0ZS))P;c=aF8&Kv>?;|%8Q@r9vhXhrP zf*xTT`7wl>Efnv8jqRia!|mZJ57!Un1LzRJ@E0l~wWPOyud3F~XUmGn*m<8vBw{WQ z#rT8FEWwNXobO9A;5VCnwjZ6Fa6+D~NyCKP)iQfJ0%P2D$k1EGRXEup=2IhG28r?n znCIjXmXcEd?0e(H9peIrX~M@V)Vk5bw;+(^apbK_y&s8=YZ4$k0oSFPwb8G-V|no{ z-M|;m86V5!{rWYh5o z>HU(zdSD;gEMrNos)YH*z$1oonov<_6FNeA=}shXKY0qR{{Vr1{HR%@o=7|e3Cmk? z*xb!%Ob(mLqI=*~0Ul7GlT74|2izW?>pA`~%?Xdv_>~j-z@ZXU-xfdLZNve4ILEt= zFuP$6545^HEK0Ms0L^Dpyw54vNeFbz`wz%*IFZU^ckb5vGOG6qQ#AA=4*d1^Pe|-F z{UtnXp|!avk;_^zJaFL;2c{a*1^WK;_!DUjZpV1Hkl<_BE`)ty9andaT*iw30ifb136Lg=z$BhlC^(?aWcgkP^>@oGeL%^~{HZ2t2^b*Zi^UBye&(E=T+ z?L@KAlC_&~T1wM4eyXC;h0Weh3*!VYsgRJN5jy{$_P#r=scdbR8AlyO!AdWqfCvT< zkSax`ND&aFgf1W;0!DfX0UILHQ3z5Mh)D0fMClMZlF(5)gx*3z0(S-UoH=vOckcJy zdw=(@^B*MHd#}CrTJL_#^FB|#5?m{+%p1|i-1(>y`5Y8?8%l>HUGh3nO2}~Zb_M#) z8(yub`kh$*MSu`wbZ$=#e7#c}UY_~&lKcX$>5$L>KQiK%4u$VDzwLSE)D$9Xs2rzK zVowq#P;~PH0BemUXpQP6R-B?c6Sd(cyAjl>|74?{T6m=qf2&M)gchKzXaJy^hE>hx zET}(%(tqxUJy-~2KRr3L-b^en1l8CBdlgy$uKtB)#{TDM{}$DN;N{6bH-b{J*nj`| z$3_%8Z?=SE)t{rM!V#P$0MY!6e*X1&{vUq(9zVI}S?0BoE`0llLFmki`}U@TogxU> zr69_pBe$v)w2KI(^8DS%<&7&GHBHV zkM95MpDW@V1tMnxsI^_F&Vm=fb^)*xJ~{VdpgMMU@Rei0%W`RJPCeY z(;c1;up_O9Om^vDo9c`%eoh-n1^ibiWR<{&o7i7`| zcuz(udT9prfcSPFj%+g7w{>XA-S!UMoUEWIR+ZoHAhXt|^ASz2JikT5rF?M7jzQ`# z0?;)UX45-!an`NB(_GU}&UHyKtp6gF<&^v}a}OSjWJn(D0|1wxV=XDYVl84`=t%z8 z5zeNg_%6u?o|-x{^E7IDzE2X&Oq!b`(^5%luOOshw|5=9%pVM~RGFc2xy$;GsM6D` zi*)e{Q)X}K9u3^xc)$i`xEpGow`;bL0r%N^a44=`e!5`JQ+n07Jz@ z>a*&Hk9qP>Inikj;%D7uSsKBr*5M4D8Z}qdl#u)u>|D8Zl{(_5U}3Z#-&tLgO*$3G z%Og51tuC9Rrj|%tsp;B!)vB2x@?D1faK8j~8u$%&D6nhdUg%3AS5FBE7WiHkC;-X# zv{RO_&`I7?Q!W*hEyMjgDr&G41U_A~S8#MzmGt)Ab&?6E4gkg>sfZTpEf+P8NAQ!5 ztR3KgjXtsbT5z39q@qEq6C{l8?iW#hKivQ}C|F`tbNE01N6@(R9)%w28+4O~hD>cI zF{$#>)zh1ozkMW=QXjaiRtxN*bTTi=?yO6aXOcrR?SKVM{#kgj#|x`9 zc`1gPl;LgE3xpY)7)c|@K zdsV#$)gpj&#P@`N2>d$OQG4h3jqxb$x6}K)3*4pP6_I!mf?75{;VwslVk@aaU>IA4$J;#D3gb8d7VP^QfZ-k=|SKKH%sTs(uUwGl{P zXE)H3?sy2k62)LJd-M*rtOAwdSb1;ybpPp>E{5yT4q(uRsrwdD;Th-p-eoUBtpDkX zQJqcd7dXOIQe?Vzt}}y1nyDj(dN039AG68|6cbRp@I4OK;V|g`Z_jXcyqSd zDx#aQh|tN+^TzpYJjy_oUiwjN%t`0n;1Mnn?(ugoq!zvv8b&w^1?>15D}U?}c>uY} zk7y2x4ip@{dZuF{i^v|@Sk+#?-J5Bp6{G?{C195ozfWFyUVSEkc8t!i{@6dw>?xL_ z&D*V?j+5k6r`LCTy#qdRcRO3e3I1%EHo5$E=vCc$)py3-)Dpt!=clx-Y&5mr98@J_ z+z_@Hb-Uisi`YzM{Ccq9UfoOUuZ7PtGiL@XXao6A1B6Q#rg+KyaksHvJ?Sbe1J`d@ zoM$-avoZPIz*Q@zXdcwi*K6iy`JA(Ge|lnulz}EQsdN5rH?z#f6sWFF|!3cDW5Ms|vYw#eWs>d8IEnVHi zoNB9^us7zLXGxDMaf%Da}K=#EJ^aC4&0 z?_k-IBkK(;%ieMa4}}(#J*3+D!b*H+-lDwegQ^8twA8#TG*|Vsp)qWk+P}t4)=ddQ z9EC$R`2l{x6k552E0dXay2Y*yT@-4%F)~gH`$(J~d&Z_Wn%E-D7}-~CE>-f)HP#I^ zP_8(!d@zS-^e)!PBD6ZE*69nb&~38XSjtf`giY#v>U7mdoYrGM)H=XQ5So1rH=J)E z&sxeXUOgwljx%HJLZK+ElwM1@UDWglqHMsmC>!Pgx{VhxsPDs5YgKTl;4mR3l~U$u zp*7g(>O8)d&Ej4zvlKP0EZ9Ugv5~5}w8p4BQ8xVWs`=2jhl6FA7x*Ey4b5W1dQgUmp}YgDnTX$&u3XrrON_Ww|1AFx z-c2#mg|n@!K2=wCjid3Lo^Fb=JCzf`kfx%${@m6k@=Kl-n^P^1Zy{itO#!hZJw}OP zfIg6~KQ+-evTvDZ$#af-3($C((Gq(Ox8mXkX6WZGr%#!&qI5uSYxXf#xCwU2=E=4v zfh5<56BB{q$9LiPvXLusjJO=KbWY)pqhw;@=8&)Gc#k*xLdM#fHf89}k|n-^kYid| z-N8NobCp)*X5QlEImIeWf1tdbMBGgU+OIh6%F$zlP>Hte#~VSx zta1qluuB_}vc6IdmR%-ilH`tI&RTLfA1DIF;&zF`4Rz-ZzmScWd8tkc^F!v83rQnq z4h&)iO<$og!6mv~+MA=xSG|QUXg>Kt~;X1gt%ax}b5a2=A6#3WVr!6zacFTn6 ziG%L^Fk@3mO5FTNm64mgyP=@e4vc)`^HzPM*CHi@(V5&!>A!yC?2m_Q>Q|4q40dh^ zSj(Fzgs>cZ|A(jU1B-_WUV0{itus!R@k}|XfCL@{?p*ogDBwr& z#WTSYT+E~$M~pW?3P(1+M7M`Ua#l{p4>iDA=t&7z-)u;GC(HY&6#_jwiZijBU5q)X2KE%G!S-OgNjaY4!=+?YOAEaCN*#HCQMmLU05uz0J<-krsAUc4l+S=TUZW)1yXwqd~f$&KU^B^lbPr z7p?_)GA4Sw!y8fL%l7E)P!(Lip`qbxaqKe_s6-*q|Bt!B_*pB)z3{)sn{FrecmN`P7h9 z?vEeJo|KZuQajB-FOz>-ZZvCR-n8;WP1{4(r&BWZoC%C{S2wFaO=w}Bj(xb(F5&H3 zfza-kaH=0V=<9pkVLcu#F0PfdN~-1!Z$K~Zt*^1AaESqFdDTsW34|upD26YCdW9u;AZRT z`Q&sJ{F0JmInLbTX@iOMJfM~Y;jMH(LQ(Jqi5&ZQDpKE6Sgl30Lx#(yBS9<)Abqd8&b^&> zAS;LV>jAgzx~bmr zy(iOi4=wpQM1 zlUKF)&~&EpT^Nakf5tCJJGXs%Esi0ykl^W#q}$G4^UA?jJ~B$!*yf1FTkS%e1e~xa*3yj6 zL7Tc&jZ`EBwo0Ih8kQW>g+G>A=lkP&(99w9RU!TMgfL70&1m#WK-%#;;}W0;cJ;F) zq;)7On?7q+>vX>um_|v;Z3@~0tQ1V%o%xzuNgmL|qjNISyHL-;8&wORJ3o9{Nv8;`o!ua5i0~}F$K@#$18NOVZ z4PD=9v63Qmwzl(^BR4!8`mDGgMuu-Q(!rN(SITTqhz|Iy&26I9^oA+UbGTRpzqZDA z9}b<9xoH=$yE4lUSz9{`UtUVblg}{3-}4b1iln`nxnx&$rPQBiCebGT1lT zJ({4B_f|p=>hg?2tdoN1CU<;rAzMuDkog)9D}0){fp|E=l03z3iT^&k+Q(; zedg$qP;jCGHkh!rOT14p&bP=mBf6T}Hjd}gZxj(U%a(fHSudjBB@Q?6E-t9!h`+UL zPkm2$%4v${H667%wfQ6JDzf(JWG#aME)Utf?#9R%-`=Wq*7exbOf4EGdl?qi;IqE0 zbsH}e(cD~z)i~|gzM2KXNM)bOPrk=da^uRe<>RIqsic>my{euLqwOL~_{)mrFC#NUnZ!a5^ z8IUKN&HJ-Vaod_wn36_^!4tdkiG8(qu1ZX1A-vDo zNxG9>XeIVBxr%*E$g8!O8rEi&ajx4n`PE|2S#tDXrJl+&rc4T}cMqrgv-ZX=wwEuN zA5kS&iof;^*zK=%8vA-gDoKL$)e6nqcQ}?G#pSD{$>vqObuz!phQ2xA(xSri8bheK zW{mHnMNG{>$_L@?`|c}97=Ksv{D^zgMl6=c9 z9orH}4=sFnKx;P)u{5VkC9ObAT8m#&=k)$ob_2Trx`IiTvyUVhl{uFo3JS4vt@|%8E zs$ec$YiCKRCA|0Yc%+i5wEvdP_;>N=KScIt7%u&DP+!g>KcoJ=?2q;t&Jp*;p_RDe zuA2YyA~!1k^#Bs6>4~2iiM@=*7m&}}QrstJJR*38;WO_KviZj#2_vVyN05Hw8Li*J zWz|r1a4?`aH8$MKL;#o$&F_G|aXG*dpk_|6QBxkESBd5iN$OdsVBKqvFG8MZQJavS ze4{2osGwb%FVyo=Q{6Pr0BfVSg)zt{|K<+{QTLw{{$~#VvuyseQ~qNd{$mgS^G^BC zYxF;!!~e!vdVp@^^c~s)?K}H!R3Xwt@5)a%>^&mRN(q1k_I<5^+CP7_F=XZE41IE8 z&(a!Z7#eg@9W^iG?95Ck)kn)^C~A2e?=EZLlXlW$C!NX z0l%+FAt>CZR~=0~sFCK&%G1hi_E!>V>Jc*eTP{3rR4%fY3X|uW>oP z(2tCui;6vp;l5YtXdG`0wfTwz{Jxr6r*tvjGOH%8eN2KGrTtM*D{N_K|3En?J)a7x z-sv`t1eLNpw+u+zG1XgUoPcXHg#G})H&ESS>}pMZSd@>+HBwK6Xik_5T998@RdeFL zqq*|SObpl5u?Y28xFM;BcIqs+*aIeNoYw1SC1|y1qS_9vP-hU0=sb8q*nH7Jdv)CU zdca`g)3f;^XL{fUcSLMV!Bw6dqE=~#{OX%MtMq{?L(=_IUQ5kktx((pzepZ~JQC*b zoMsB7a>?m@a2?>;U)OhLWROpTKn$3>t+*3T=8R}ZgOodC;JW%lxB7DI+m5>6$>Ua8 zm%z_EPk@T2Az}vBRj81m#YEhqi?QNyh_4t^1f60u4}jBe(q;lBr{w2) z04lHiRL~6S8vMpn1$sk-tO1ZQG-lK_lQmpB=Ga|z*IX%T{*6H#;J?r*`JMs?U+@0- zI!VVnGp}BdhksF|wvh$gsCA-8-@OqBVW)qb1ABJ!nu zsFN-$5-DUB#c1mB;k@rI!Pl&nfZj!PcrxK>Xx{cL1@9fc1gIaf^&E^jWW5TLUXi~Y z1{}&}z9v3Ij9Cjx9m)Nsxv8@=j7`qF)V`W?XW1VMbn~8AGcr)pOaWUIwRw8xVQ<4^ zs4v;l6L42xl6Fl42f^dD^6==pD7ooPDqe8Dxd<`ZHDSafc4?kyri{W|%O2d^<62NZ zV;ylSKruzW>Yhn~9+j1y6|k~j)hTi$zDXo2ntILhaFvHuZVuShTUvp3kWrSdU0mYr z)dp4=(^}u!E^e1(mWA>#s*?PpN>(->u^#2Bk-P|41Z4AlhZCF$6dNnF7aP7r4qVrq zG3v&L&ea?$*+uu+sQc$nhCf%;HMHP+SCp-^Q6nNEa=tNyT{KC(sjlvYHq_e2W^!v~ ze6{5gpx~hN$TQ}u;1egUJ97FYa0!%%phs~`jqr`{s! zPq)bWPn{y5(VSXL4`zbjOQNVYPt2pqrgkxQ^y)r$0DX{iwTD`R|2EI54waGUPt(De zrn*;k3s&_v?_-IFr}X#uD0DOe758}@^LsNzt5m`K&&+(vOI4gsm8YZ`qkT+3v&yI{ zkf$ILJ;&X0s!8c9`l}mOCU@qE8x9%eVt}XZ@Wj}ht5i8k|Bzs|;pxH_SqAq8H~d7a6=c+lo$Gh?pkF6J#Xjn5ea*8V-t(u_`=?(_0LBru^Rm2N`Ddt& zDA}p~wsRUVQ?Rz^cbDmvwY$3DI_u}|Q3-Fof%qYnomDlp*YaJgs387&Hleg{QhBsE zW@tuymc8_1`LD+EniXo@DYJs)*fcit6PAoejYP^#&c6G) zF;*Uw?n&X?JVZ02Orq%Rj^!AB{PYcLsCr`$T-PEZKlFg;W-<5un!Z*2 ze1-HE$C`r>{b|@MH_e6HLub|1+hdZL>zj0;FRg=UUwU6Kjgdn}MB_K_>=9i=f{qKX z9^CtZ(yxAsOJZGJJc_%2Q~{t3L`aA=@zh5l{IAJ@t%ESML#t&+4h*lcq}zY~=EC^r zbpRlZcgpuTRnbx7MEPVdyorS(i-tbg8Y@-4aD^X?`F(K&b}!$Tmj=w3a?2@)~Z1Rr4`}#uGgjDo0%)ScDQV2xE^>l zUV=0xfrhvd5`SH>u-W-G0hnY9kg z=XQsD*SlH@e)Vt@8k)++gl@kVZQsjuF70}wSb@1a5V2A{Ly@c zX0_17^!@YkS2~0PI3R=0-(|Dv{ZNuH6m^7PX8oU1=56FJDI+89rfN0=qGN6}u?-e9 z1XMvZ<0Q>*Ik#uPjGAToN8}EtKtMYRt}HjxdXkt0x}X}Lq%?fwj;-J->uT5pLWndp zMSFzidjuvTTg75_)qXiG0z67SXgwG&rihZ@t-@+d1|T@oqsBcUbctx z=vRUH|YmnZx#Awm3gi$A9iG-yYob8D+qI1~YmwlNo`+szMr zQM=0A-`iss`K0C9hYrs)Lnank?$*3YLqDq@Y!uT5ykbkEW!`j04$ypkKMLEYKc{Y8 z>AoA~X6FNrtSN4Y9DJv#9CUhxb0*(BF4dy=X-!Qj_jyWED3j=Gl}KAJ%Oaf{>2WTJ zO|J~#bAZjvb=~~oUbWp_H;n9Z$0E=CotPjlb_85kiF3epaY)K@I^KPPLKsE*`5h#F zdrlv;3#hP1%Uv;B=$$jdvN_ek`T#0kZsO&Za79Z+sDS_O0a?&UVSVmmf}-y}_e2$v z@g)F|zwGW)B><5$%C4#Ilh*v?a-B_3t6d0B7&EtD+;$f<)51rxCu3C!bEARVB@FWS zfY(jsyQ0Dpt$bdr+>0#eZj39q09qc`DDMqe4--x?I_xgn1RE{VLi5=Y|P%Ld2(C}Jvt|U@I5W? zE%Jdup^dTde!Kd3Ygf@KtHx=zo2PlwiOK*denxhwwe?n8sMsNzdtCW|trF~mi;zz+ zH|TlLA9pzv7f~~o!fh$cY>Hno`~^snnE4Q`#_xVvA2lRy+uEgm0c(HafN9DwfB>9#;W_XOC07={n zxc;{-sO;+0wYASHQJCn1rcAui+M~SuN1vxVgxZq1M`=#;gz75&jlz7NmSP_e3H-9a z5xRYn%Kgu&{+xFWV9C=l+LL;ew?)Mo$$7gU$@v<5%aM+Sd4zLQG z3-;-?QrcxN43#4_l{4Dw0GCeI#Bd#ELnSWkMo-)>4uw|$xHa&v#V_tFHMzX#HA{#R+HG?rW+3GYvkfxbC*Th~M=LB$?9;AB zNOfjg0pH$*?#Hj6Y%BlLw{}Chn!Ij6EOK@57!KDb?6FnukN<=ZEevBuX|p9xwjB4I zogI(ZnoPz1w(xX_TyIOvfN>!Gccx0ogR-fUy|MHx(NhDpPTLXO2}M(b?s}$(*%vZ} zOO-=n7v?;*nzTmaBH}mmH#M4b^n(Hftqr=?X6DKD>}zw8go$28AHm(0(w(#Y#5eAl zR`9&VB{H#FTGrk4k>E&J;v&4huV+0cK~?}ZveO!4<|wr5Z$QkwrvYvT$_u2Xz(oFD z6)UuBTurXgHHhq(z{z_mad@4}*nyQv@eJ-<;DQOxX01INLac3cn?@VXjIc;U8V z%=u{Z9i#&-aCPIQuYtLgpqboqG1*Hs@fF=uRbKfr^IKUHBefPB=ZhEo^{x7$ zk@P`>Ft}~?x@1cqAyrN7`ta!M@=WX!1~kN(nsm}aqs(?Xi82$xlMCKNSurKPp>SuR zPZs0e31DSlpYH2r-Oxk^=ue>Rup_@&!Z7%VJgo<4k#qF22t%K=z!yeYwjnhZahz-O zgHAm$N$P>xLB@WQa5O|nQS^hSAOrPn*&iQYkMy+|Y>l~#RaSwsUVZ1)bd z)dC@5XDL&x1-Q9qlY1Ir&rXPH6%&S-gsu{IL=CDC3L-*@;vK@ok8;OaV{}{%k!PdQ z@nDF>>6Q zUuu$ecdZE2+qv;M;|Wz0?8C-)j6Bkxt~HuB0!h?quX;QrdD7Pa8Jx;HfouraXsPk+ zPowuU%%#4HCQ-GOe#;SyCos_Q!Q4oetACk~8XE^`pNKbgI9TRxJ$BQeTh zF3${A2Ld10iT(Qu6H%}8^~6`ZmcWlUM08bbL$Z-gDJp0wKWZq-*2lq+}O8GE5Il_L4i z2Ncj^0C*j{3MiKwXw{|OY4Y-PF;c06PR2j@k(5yV5jnsTs87 zR{#!O=fNZNZ}k!O*NwEMsfgp6Mg^qHN7dTt4kah*zLiRw1R%jBO;u7r!pqJ;&ypOZ zZgP8(om7&ZNiI=d-(?jNFpw&DO`Ye&w6Nn@QhSZ=ib&@wxW%u>3`7HB!W5gv=pu6F z{L*YV#ldIiiC!+P`iI*Oi25D4ts91d!im;PfPTQYy`Ebt{7twTpgg&;zZX#B(SG$N3`YY&i;U9!$0Dy}X-Dv#4}(K6tNE*=pU8>cQ49sw z>_>M>Zw5f4L@SD$q6B2~Ei-lf4$iQVTt8uyu8wW6B&xrI>qm%U7b5^)s>@T=ThVZ% zx8zcT+hd!K_kiL;TB2__RBfu&j)vykzVYmKOh@_|musDG_^nFfzDk4Wk+l=ApZDb7 zDfU;~>n*Zjw>TN;@laW9ItyElAaZb2eF@KT-0G1=POWV`?TT-SWjwMQ~rQHNbi_!r)__pT0&u;xGk8nK|25$3-5k^?< z+W5dZ@mQ3;#%Lh|4SI7uB4r_wa3g*~!+hA+uhGZsN4aHXL1cl8o>(+S>NpY)IDMRN ze~L}hg@On?Ypml}cWRQQV^H!gkwtITZ7GQ6_5PuAxmcH-b z;#*L5h3`4V)&T#7IXDP2>FbdW)pHRRCghV#^umSJF^xGsjWHE06<3BLx*88pBqirT z5{LLI+KrKU`87`JCL`Qem2)upj>P?5`loyu^Tx}b z@cay_uMu^A=Kwap>3#Igx4mVEdg&S4AN0t%JdF_&B7(FMBjRd-RgCq5keKR4AHdn} z`S4QYOQYmLt9vaY>*(ay&4N+|nP};wn2qFotHDpM-c?qvYKOemE9Z9mr%~=0ZCxWZ zr{qDb4s`Qs!t1?ITcWgdR9L>#aN}rTNI~HhLp>KDs^J{b?eFHvz)&@fg~ic0yG(0-@fM9?PC8Fa&U!9yx^Hg*5AC!5t2#^gYd`;2q-i$@2qy%?ES>) zLw;s$LFzW*V_g@r5)mWT4D&}id-2BOF$aFd*Q}cLcR<2~C zoi4P6P78Af+9^kJEiErMlmHZNV79Xi!RSW(U%Z>QtsRr0>9yuK6%}^O_sv0?8})l{ zG}O4qg1IAYbuJUNk9LpHxj=r{#sQ1U{UpXYY`w_W1vheIuDB(0R6Y3FH>oOnq2K)u z#wP>qx?7c|<7at?ub$Pr-z@j8KJ7A>sw=Bz`QazaD|=RbR??6d{K+i2~wrIbFqa!1O$q6qwro)x5ph2M~y~8dk_YW1I(KMTySj>}>&#DA5SPu64x5Bj)+%u|j!VAL6WE(W6CW+;_ z{b0FnF^m6m+iZXduCZSV&pL2dPZb(zboW5MD}F6POf4v3#7LTNR}Zu!w^_l4eY@fa z?aa)51M242AN*ztJp&g~he$1Kt=GhD5TGr-4G>MGn1`)Ei|`KtE*J4bVpZ#TwMBAR zXc-K+V8|1k`=h5RR(UgPFKqP^d`qxAOWjp4^NCC7ZsXf>Qxe zzIDPhf5;3?CcgtQn=}wz>*qX+{S~YqigtrEjbW`IWI<&Cw-wPEQkR83i;{oC4qJz?Dk!C;9~6?m}d+I5$`_uFx&Pnp7q;*m3uFLd%7pR5RUUO=i}{} zP2nc7@$g`I1MVAsbS4QY{X$dIy6+y@l|&2gth$Uo)@#{)J2-H8U-`)G#h(1te#rBJ zfhvIoo^Ug7BGbX--hI8)Kl=edE9qY!vC_!N`cFrgls^7K;(W4^G|I`s$JypRNmXI$ z*dNXZ*Nr*d@i#AMGC2VZ`A?x{!!I<$Z9jhlI(gs4#wHii;8p%EhCo$|4#T+y9cGT%b*8pdn)dV=#PAtXmW+ATD@IM?E6Yt0@Hg&dM^O|Z%Xw3j|0$Ww=vUe zWE33K7gK7JMk`>W)ecp$mR!^sOl~{_obeP)%g|6%aJ154c}12u}NA##Gl2_^QCalG~myi1MARV*9(Z1_J%m{nWjO zkpJJ^NSbTg{Xb=DO@9Q;)YY?}ZP+iu{BT7qCwWeXQd^;CjPzcf$9ry*eqQdV-wh14 zrt@RJ?kStu{pD)vjp=4kJtt<>&6_+)ul+RlI*=*I@wOVr%VL1{DS;!h`o8k(H${VJk04zr1N`N^28fdz<2^h^}C3KsQ(o{5`&pK;e_?d3y8= zZOEXFzgm5&-~OEdeW7uPKycJq_McC^I}dPK|D%k6LUGGcbz_mKgX(E7m?j%YUvv`W zR9OWY3_Mz^guT43B)na(i<=1a4-pFm*vMI#YI4QN187jv^>{@s}stOs^7Yk z9(QI^^i&BwvD@DhsGQz))l#(rx<1V+W{RgyPxXtm{anhMKtawy{pTVC%c8))o}X_bNax z>>Jj9+Ds_+@Bh5-e&z}Px+V9_@L%`uKV$=c#KhFd39P{Rn!SwR->v*VWd(nlf`646 z{Q2F#%MSj0Nq`KY5h(m#1QZK};UKyAL*Nid!05}7X1MUCx!OPC$FD%+5FOuT`Id_H zjXy~l(J*+r7x#wpQTYUDo_UaCmj&P0`MGzT~Gq$gtP!sczQ5%~&p+np_q-@6wl^?U2q`ez7* z{YwZ;!sfg8r)_b3g0R8 zQm2hEMS8pvKNVw;Sb2YpB2pd2n`1|-e!7E~^~OSh;P@Z!aa%Fy9P@31uMaikfGo!e z!ykrPn9?u_fxO;sJ15WAT>Z%_`L)Uwx$^~=up2Ec^RMcXPX;KCi$q9M)pQ;5FST1S z?UUSgJdcr()$hE^w*IoZ3TbogWny5{w}}Wbjr-?@VW!1VR}+}8MClewG&LghOqR}1 zlc2D9v4q2K*2L$eC^tFrZ`3jG^W+c_EO+qZ-aG6JHg~4Hj4(`j`bkO{efK}oO7X%h z7|o_H&*w;=%HvJ#gQsiY?6ID5XQv4|X_T#uAlj?}M5KVP_D6qG*0j)tfN+BqL(~Aq zNmi@a5I^l&k=~(E^W6 zKVE3Omeq*uB(^<2L%2^p(+V1S^pu>$n z1iWWY7=J#Eid-lh8qtGQ{t}mB0WdK_>AOPBt+#Ihjqy2OHK1k|9z77PjXX*^abROg zrzlsETe$jtRP~+eAQ99k>8y1`i03-1{f!Ij2ki`miw+h|jIe&4L0}D+MA}Dh%uRnW zO~89zw0v}osl%qW<7tuocnC=4R!IqIw7fS=Tsc^E4*HX`S2d~7f;eYzi;$5d`2qPr zwuJN)iqX^@G@=)4P|R}8^pMMd)HV~@#Fw{Z8&LY&EpSF~vP>16z&>{Q@UT ziLJz>llmUYXtgidWf9YZiTN8YpQNhU)3X5AFCWlr#82O8OEeJUFzcPp?!qN)$gZ-9 z(zQ4CF5>uTwEn&pQ6uEI0J?MuR=aWAJ>J}^Na*T#H>YY#p^s2EtQcWi)NjFmD=n zdu_=Zh5}@@`ErX^Mo7DADMr2f=R{|`s&S>>1aEOdzFqJUUV^lAVuv#FyEk3D3@6&s z_{_)NL#77^lg8BvLJ1L>EZd8{7oFs9wmW|FNr)T5>kB_(_4digvJ}NHvK=nsK$;fk zeTM>NKf}=3bI!0-pJSW&CJGaaXE3f@E7dTxtZT`xh&Y75JwZ0mQL5i^`&8WCzR}G> zDbukt%xctkkc|uN=vW(P6V+U7w6bdii;ef^V)GeyS~S;w?(;~oN(#zKM+)vXd5|f= zM2W@aOV~}v=Byq6h>dl5w;KE#qEz)xmC@|BFx}NI{*h9)65C}tyKHwr?HfG(p@k9! z(iWAtREz$zpKmhRT2^)>3>Sn!Geb$M(*dwik?#x&`tRCTq<1MM0wm-61s zAtm~B%dAB7OG2*Xi2eFP9IRR?JNQNa+q##3A`zD8#lqZJt2zwvCJlLV!8_tmfqHlI z72{${)7YKk_qo#+d&nlXz0*c^*2LhQ%|dMSr=pODN9v~wup)7B1QWuFJ~Ly{B8Jij z@k3=E%Q!9ohgW{WN`A_RC}eFok7j?F{x~2_GIGcJ*vSf7cBmz$q-G^qoJ9uc_|D1= zg?<2mSKIcw-ew;Qr5YOpOuTz`>fN@Lg)IB{;EnuEmW%3dLaOMCd<1)AuwOlFmy4iw zt&&oSOEhMwG-^Lwc?(i-MrH09h6Z*Re?fy|eM4T)!&)nInRDUL7MWQr!r1lvn3rY# z$h{$$xR``>T;oW__F|}Nt5i;2=Bv8k@sTXc_mmNvtPR0&V@^DD(W`MV1GOax!8)#6 zVcgp7dSElcMJw-pmCCR1a*-t6wvShz#Yk`@ufektj1U(S;Qd8Z!=j^pQ8rO5>ib0H zQh6x4rSy}lS;!=Q)FQSKd#Rzp1f6n8ZXv5d@{>mb+ruog`i1ly*uHfRem*d61cNq? zuZ$fwZ#`DelkhmRU|aagItzGT=u+~;HW68}*z}+u_C!5ByCCmr_L7#sXG%dTwgVL- zUqB8;Hkbt--II_X1p<+Fh7e40w+!5WcGaTIodxea*P+F?q=UFyqJxeLzE#C=L_Vt)3hRbcbK$`9KWr| zoMrA|VJeA=>ByOuCYiX0I^JGzv~7@%692|1`p{BDDp~xJz+z+Pj9n!b!JzAFAB-@= z2Z`kfFRc_b=~y0%N~>-s1`&@KgjYWonI-k#1qL|FcBe5g6lakoYy!{ZI^3qvp-5&>oiu^)Jn?;#ik&m|vIuaTNQ$rKeUn z25K^%kSlx%OX&@EKKpK4F$k!nse#Gg|8-;GyCl6IhC6@|H7-qG4@eFFJf2#m0)JmK z+V?Z5A3vbo9~kv->JeZi{BNDPyAa4;rx@t`YGCr41f;M(|4qNW-yZh+xev$p$!@@J z2L7La_*=|ipn5l<+ml#pB99bW@b*+tlDDSxZ8(417z%6oaXppy0hO00%Y@P4`P(;p z5;~5j9s4n+-&k^vZv`_{rPkxi&P9IMr|1d0HeU1#`sDaOoMC0aWAxRE*CQ3Hi~IM? z-Ra>_39Ivvl}G`a$@}eZ4=Tk+BrGZuSnn|Jx60jkgF^9m;Ig;P$~yG(oFLF%ZOfF;Ns!}WI$OjlcqNeUxt&@`oAEs;HH3pj(?UpczDwLlQX^zH4!8p5o{8Y8fZ8 z;X6^2ALIH?Pt}Z>qTBf(W>>P9BI_R@5$h>cBy=9$EpaI|?R)`mxt8Ye zSL8+m$y_zDj~CD-OqCT_hnK-MG}#6mOc?`O5^7VeM)+l=-E-o@6grgKs>J#CdSLC` zd#@B6>%%QcnGgHMPnO+95WUJxr)8byzY1?iX3oMxno$)YR;5d@tvCo%PbIbk0_ix; z`351pCWjZyv8QCn_#dyc8?W;6;W4mlY*__W?|C2BVfXfyr}GC4#Ih;3^5t=BRlK0c zkQ#yUwI;(n7xh<*IETaB^;$7rBSy|^As0a!Rjq{1iDTERb}t%C6J+Es$+NQ|+ZqB4vVfn za+KNMZ274| z@1J>mg>367cLV< zW^K(pkVCHUzB}Uh_GGLehglCsG74FNb+uxUe~Zr6gI0^0!QaV^Z47x>n;RyOV{sEY zRgUpMlv_8vZ+G+N)a165RQBt3h0*w8HGc#Co#l!*5p6<@sW8NBc~MXtdHrfS6QxeN z^;U2|;-aizC%GNb`UNj&Qqn;$mW?g4of{w$pI#{OK1%R|G4LUO$a-PW1-V?#ALKqh=Ff zan6fh%EZrC1QMoApbrIerbuwGm>R%hde|O&_<7cdcO%?O7**qhN5Yzsn`U90WYSYd z15WXe>TNi>DlUWM7eh!(4$Rg-ETPS*(CH=}6Hb@o)FuwSUeXGnj*n!VR|;j;B~mAo zaD~#uZxb1-og>a5$G1C}p6Q{1mOf{cF&vt(*_vV})2dPlP1)bv{WJ#7=4CE`5YRCW zZEl~Lf#)wUQqDG58}7gqsi)otg#1#4uoBNZzL7QEo!|kNk@@lV8Xbvp-=c9L)omP7 z=4^sGs9YTbQ_4n8B_bJ^-W-;U+@_jJ!ny?jmtQk2(X5ldJe_x`?wcg9)oxIwhn!G9 zITfW)`|wQE%c%Z)zyfy|%L(}QJuolZWi4|fJ|nNsyr@H8eU$KiNe~ip=Q|+3<~4P0 zHR7<8a~*66!f54yNO8}w_tOw(wS4CcG%J&)v!Kd5g>0Yl4qJY2;d$r2$o?rmZ?RHC zm>|>~9xc}~9>#XnQBTmsD9p}w+5uFAvVZ|_C*p5IA7=Yr^Fz&@Gta?zj1X1L-OLT5 z9PJXyC&x-%Rrq<0HWiI?z@ae$5Z#aO_Fqx=4@`VbyBpDbUxxOzs8<3&$`4yIi)oglGw5wzH!t%b z`YkO7CF5FMRU)|v9UKu&1+)3bx9qqo*jYESZ``)=T>NV0v+%5I{hWDkl)gLV06*k- zoXc)|tXFkQ%_{C8hlA_)m(z`$gOjx~yAy@;Rhwy!WrpU&0e91!id*tvX;j`FPuZ>@ zEoUma~|*a-m75HRfG{ywZI+L zOY+2KEtzD1Ivnu@tpHZkoZgp#(tJ=kA`RKD{pQpWykIAiBv0DvG{CzNCO`6@%ASX)br-DzfqIW3FuDf0%@YTf$*42$v-7ms|clVs4{9jfFM|ZGW$zkQC zUt4Nwo(Thgzy;u_-dG+^D3S}&M~%_n)a&nSH;V{AfC^m+USN%KrrlhxaGLE)7%Q}) z4{Aa=PniZ6G#rW@_$F_Ks9X9@dmPdc?}f?HzpN9-slXQ8Ts;O<*w>I*W(P1CWjkNa zGQ^X7CA*VzKY42m3+j`9x6pkY#bC95lVlm#yS{XPGD`_=czxtuImCuxV^==1Bm^*3 zyxi%tv@9=Q&{&g+iNUO&1k+;8AlR(_d^}$Xc_Ok!p3PG~U*5AfX6LnxxFjFrXhK*{ z#wk&4l#UMDoGZZ#AW`KvDb7x9JALE%p)z`tlNF~|vCj~{%Kvb`TvY$+F#Uey%3mFx z7r;piCImC(Ouy85xo132-1s#Z*RZV|gmYHlSJ)>gIQJA7J_J|8U;Ma#bg^!zy#Fu! zxI+5@v7KGmXov&Ti>EZN^GoiEs2;jz|I6$NqZE~s0V6XH%2+Zd&T8Ed3C>wXo{K+j z^9)G*s>>$ite@D`vN+UlFL@ex*T!=cBFEv)QmZDqH8fwFfVo zAuk`I9;`R3#@DFuRo%F(&fNlh?EcD3FG(XwTaC~4u<5aLBj29qE`yJ0RFyOpvv1sc G_P+pGK7926 diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index ddf9767f..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. JiraPS documentation master file, created by - sphinx-quickstart on Tue Dec 13 19:31:32 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -====== -JiraPS -====== - -.. image:: https://ci.appveyor.com/api/projects/status/utpel25via67xw3b?svg=true - :target: https://ci.appveyor.com/project/JoshuaT/JiraPS - :alt: Appveyor build status - -.. image:: https://readthedocs.org/projects/JiraPS/badge/?version=latest - :target: http://JiraPS.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status - - -JiraPS is a Windows PowerShell module to interact with Atlassian JIRA via a REST API, while maintaining a consistent PowerShell look and feel. - -.. note:: This documentation is a work in progress - but there's enough here already that I wanted to go ahead and publish it as I continue fleshing it out. Please feel free to submit PR's or issues on this documentation over on the `GitHub Issues`_ page! - -.. toctree:: - :maxdepth: 2 - :caption: Introduction - - getting_started - authentication - -.. toctree:: - :maxdepth: 2 - :caption: Working with issues - - viewing_issues - creating_issues - updating_issues - custom_fields - -.. toctree:: - :maxdepth: 1 - :caption: About JiraPS - - contributing - changelog - -New to the project? Check out the :doc:`getting_started` page for a quick guide to get you up and running! - -.. _`GitHub Issues`: https://github.com/AtlassianPS/JiraPS/issues diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index e34a76cd..00000000 --- a/docs/make.bat +++ /dev/null @@ -1,36 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=. -set BUILDDIR=_build -set SPHINXPROJ=JiraPS - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% - -:end -popd diff --git a/docs/updating_issues.rst b/docs/updating_issues.rst deleted file mode 100644 index df9a94d2..00000000 --- a/docs/updating_issues.rst +++ /dev/null @@ -1,108 +0,0 @@ -=============== -Updating Issues -=============== - -* :ref:`Editing Issues` -* :ref:`Adding Comments` -* :ref:`Issue Transitions` - -.. _Editing Issues: - -Editing Issues -============== - -Editing issues is done with the Set-JiraIssue function. - -.. code:: PowerShell - - # Assign an issue - Set-JiraIssue TEST-1 -Assignee 'bob' - - # Get the issue's existing summary and add a tag - $issue = Get-JiraIssue TEST-1 - $issue | Set-JiraIssue -Summary "$($issue.Summary) (Modified by PowerShell)" - - # Change the issue's summary and add a comment for that change - $issue | Set-JiraIssue -Summary "New Summary" -AddComment "Changed summary for testing" - -If the field you want to change does not have a named parameter, Set-JiraIssue also supports changing arbitrary fields using the -Fields parameter. For more information on this parameter, see the :doc:`custom_fields` page. - -Labels ------- - -You can set labels on an issue using Set-JiraIssue's -Label parameter. Using this function will overwrite any existing labels on the issue. - -.. code:: PowerShell - - Get-JiraIssue TEST-1 | Set-JiraIssue -Label 'Funny','Testing' - -For better control over labels, use Set-JiraIssueLabel. This provides more granular control over the labels in an issue using four parameters: - -* **Add** adds labels to an issue without modifying any existing labels. -* **Remove** removes specific labels from an issue. -* **Set** overwrites all labels with any labels passed to this parameter. -* **Clear** removes all labels from the issue. - -The -Add and -Remove parameters can be used together; Set and Clear must be used individually. - -.. code:: powershell - - $issue = Get-JiraIssue TEST-1 - - # Overwrite all labels with these two - $issue | Set-JiraIssueLabel -Set 'Funny','Test' - - # Add another label and remove the Funny label - after this, the - # issue will have 'Test' and 'Serious' - $issue | Set-JiraIssueLabel -Add 'Serious' -Remove 'Funny' - - # Remove ALL the labels! - $issue | Set-JiraIssueLabel -Clear - -.. _Adding Comments: - -Adding Comments -=============== - -Add-JiraIssueComment is your friend here. - -.. code:: PowerShell - - Add-JiraIssueComment -Issue TEST-1 -Comment "Test comment from PowerShell" - -You can also use Format-Jira to convert a PowerShell object into a JIRA table. - -.. code:: PowerShell - - $commentText = Get-Process powershell | Format-Jira - Get-JiraIssue TEST-1 | Add-JiraIssueComment "Current PowerShell processes:\n$commentText" - -.. note:: Like other Format-* commands, Format-Jira is a destructive operation for data in the pipeline. Remember to "filter left, format right!" - -Comments can also be added while changing other fields of issues, e.g. the assignee: - -.. code:: PowerShell - Set-JiraIssue -Issue TEST-1 -Assignee "John" -Addcomment "Dear mr. Doe, please review this issue.Thx" - -.. _Issue Transitions: - -Issue Transitions -================= - -Closing an issue, reopening an issue, or changing an issue to a pending state are all examples of what JIRA calls "issue transitions." The transitions an issue can perform depend on its current status and the JIRA workflow set up for its project. - -First, check the transitions an issue can currently perform: - -.. code:: PowerShell - - Get-JiraIssue TEST-1 | Select-Object -ExpandProperty Transition - -Once you have a list of transitions, use Invoke-JiraIssueTransition with the ID of the transition to perform: - -.. code:: PowerShell - - Get-JiraIssue TEST-1 | Invoke-JiraIssueTransition -Transition 11 - -.. note:: For more information on configuring transitions in JIRA, see Atlassian's article on `JIRA Workflows`_. - -.. _JIRA Workflows: https://confluence.atlassian.com/adminjiraserver072/working-with-workflows-828787890.html From 8ebaec401b6bb23787d11c026c22b3e48604f813 Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Sun, 15 Apr 2018 22:03:25 +0200 Subject: [PATCH 2/7] Added markdown documentation --- docs/commands/Add-JiraGroupMember.md | 194 +++++++++++ docs/commands/Add-JiraIssueAttachment.md | 175 ++++++++++ docs/commands/Add-JiraIssueComment.md | 208 +++++++++++ docs/commands/Add-JiraIssueLink.md | 173 ++++++++++ docs/commands/Add-JiraIssueWatcher.md | 172 ++++++++++ docs/commands/Add-JiraIssueWorklog.md | 239 +++++++++++++ docs/commands/Format-Jira.md | 107 ++++++ docs/commands/Get-JiraComponent.md | 157 +++++++++ docs/commands/Get-JiraConfigServer.md | 87 +++++ docs/commands/Get-JiraField.md | 116 +++++++ docs/commands/Get-JiraFilter.md | 136 ++++++++ docs/commands/Get-JiraGroup.md | 111 ++++++ docs/commands/Get-JiraGroupMember.md | 160 +++++++++ docs/commands/Get-JiraIssue.md | 290 ++++++++++++++++ docs/commands/Get-JiraIssueAttachment.md | 139 ++++++++ docs/commands/Get-JiraIssueComment.md | 108 ++++++ docs/commands/Get-JiraIssueCreateMetadata.md | 128 +++++++ docs/commands/Get-JiraIssueEditMetadata.md | 110 ++++++ docs/commands/Get-JiraIssueLink.md | 120 +++++++ docs/commands/Get-JiraIssueLinkType.md | 121 +++++++ docs/commands/Get-JiraIssueType.md | 124 +++++++ docs/commands/Get-JiraIssueWatcher.md | 108 ++++++ docs/commands/Get-JiraPriority.md | 112 ++++++ docs/commands/Get-JiraProject.md | 125 +++++++ docs/commands/Get-JiraRemoteLink.md | 122 +++++++ docs/commands/Get-JiraServerInformation.md | 74 ++++ docs/commands/Get-JiraSession.md | 60 ++++ docs/commands/Get-JiraUser.md | 144 ++++++++ docs/commands/Get-JiraVersion.md | 209 +++++++++++ docs/commands/Invoke-JiraIssueTransition.md | 227 ++++++++++++ docs/commands/New-JiraGroup.md | 129 +++++++ docs/commands/New-JiraIssue.md | 340 ++++++++++++++++++ docs/commands/New-JiraSession.md | 103 ++++++ docs/commands/New-JiraUser.md | 192 +++++++++++ docs/commands/New-JiraVersion.md | 276 +++++++++++++++ docs/commands/Remove-JiraGroup.md | 146 ++++++++ docs/commands/Remove-JiraGroupMember.md | 207 +++++++++++ docs/commands/Remove-JiraIssueAttachment.md | 209 +++++++++++ docs/commands/Remove-JiraIssueLink.md | 142 ++++++++ docs/commands/Remove-JiraIssueWatcher.md | 172 ++++++++++ docs/commands/Remove-JiraRemoteLink.md | 172 ++++++++++ docs/commands/Remove-JiraSession.md | 100 ++++++ docs/commands/Remove-JiraUser.md | 148 ++++++++ docs/commands/Remove-JiraVersion.md | 157 +++++++++ docs/commands/Set-JiraConfigServer.md | 99 ++++++ docs/commands/Set-JiraIssue.md | 343 +++++++++++++++++++ docs/commands/Set-JiraIssueLabel.md | 258 ++++++++++++++ docs/commands/Set-JiraUser.md | 224 ++++++++++++ docs/commands/Set-JiraVersion.md | 257 ++++++++++++++ docs/commands/about_JiraPS.md | 117 +++++++ docs/commands/about_JiraPS_Authentication.md | 64 ++++ docs/commands/about_JiraPS_CreatingIssues.md | 79 +++++ docs/commands/about_JiraPS_CustomFields.md | 289 ++++++++++++++++ docs/commands/about_JiraPS_UpdatingIssues.md | 124 +++++++ docs/commands/index.md | 7 + 55 files changed, 8710 insertions(+) create mode 100644 docs/commands/Add-JiraGroupMember.md create mode 100644 docs/commands/Add-JiraIssueAttachment.md create mode 100644 docs/commands/Add-JiraIssueComment.md create mode 100644 docs/commands/Add-JiraIssueLink.md create mode 100644 docs/commands/Add-JiraIssueWatcher.md create mode 100644 docs/commands/Add-JiraIssueWorklog.md create mode 100644 docs/commands/Format-Jira.md create mode 100644 docs/commands/Get-JiraComponent.md create mode 100644 docs/commands/Get-JiraConfigServer.md create mode 100644 docs/commands/Get-JiraField.md create mode 100644 docs/commands/Get-JiraFilter.md create mode 100644 docs/commands/Get-JiraGroup.md create mode 100644 docs/commands/Get-JiraGroupMember.md create mode 100644 docs/commands/Get-JiraIssue.md create mode 100644 docs/commands/Get-JiraIssueAttachment.md create mode 100644 docs/commands/Get-JiraIssueComment.md create mode 100644 docs/commands/Get-JiraIssueCreateMetadata.md create mode 100644 docs/commands/Get-JiraIssueEditMetadata.md create mode 100644 docs/commands/Get-JiraIssueLink.md create mode 100644 docs/commands/Get-JiraIssueLinkType.md create mode 100644 docs/commands/Get-JiraIssueType.md create mode 100644 docs/commands/Get-JiraIssueWatcher.md create mode 100644 docs/commands/Get-JiraPriority.md create mode 100644 docs/commands/Get-JiraProject.md create mode 100644 docs/commands/Get-JiraRemoteLink.md create mode 100644 docs/commands/Get-JiraServerInformation.md create mode 100644 docs/commands/Get-JiraSession.md create mode 100644 docs/commands/Get-JiraUser.md create mode 100644 docs/commands/Get-JiraVersion.md create mode 100644 docs/commands/Invoke-JiraIssueTransition.md create mode 100644 docs/commands/New-JiraGroup.md create mode 100644 docs/commands/New-JiraIssue.md create mode 100644 docs/commands/New-JiraSession.md create mode 100644 docs/commands/New-JiraUser.md create mode 100644 docs/commands/New-JiraVersion.md create mode 100644 docs/commands/Remove-JiraGroup.md create mode 100644 docs/commands/Remove-JiraGroupMember.md create mode 100644 docs/commands/Remove-JiraIssueAttachment.md create mode 100644 docs/commands/Remove-JiraIssueLink.md create mode 100644 docs/commands/Remove-JiraIssueWatcher.md create mode 100644 docs/commands/Remove-JiraRemoteLink.md create mode 100644 docs/commands/Remove-JiraSession.md create mode 100644 docs/commands/Remove-JiraUser.md create mode 100644 docs/commands/Remove-JiraVersion.md create mode 100644 docs/commands/Set-JiraConfigServer.md create mode 100644 docs/commands/Set-JiraIssue.md create mode 100644 docs/commands/Set-JiraIssueLabel.md create mode 100644 docs/commands/Set-JiraUser.md create mode 100644 docs/commands/Set-JiraVersion.md create mode 100644 docs/commands/about_JiraPS.md create mode 100644 docs/commands/about_JiraPS_Authentication.md create mode 100644 docs/commands/about_JiraPS_CreatingIssues.md create mode 100644 docs/commands/about_JiraPS_CustomFields.md create mode 100644 docs/commands/about_JiraPS_UpdatingIssues.md create mode 100644 docs/commands/index.md diff --git a/docs/commands/Add-JiraGroupMember.md b/docs/commands/Add-JiraGroupMember.md new file mode 100644 index 00000000..e79d6515 --- /dev/null +++ b/docs/commands/Add-JiraGroupMember.md @@ -0,0 +1,194 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Add-JiraGroupMember/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Add-JiraGroupMember/ +--- +# Add-JiraGroupMember + +## SYNOPSIS + +Adds a user to a JIRA group + +## SYNTAX + +```powershell +Add-JiraGroupMember [-Group] [-UserName] [[-Credential] ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function adds a JIRA user to a JIRA group. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Add-JiraGroupMember -Group testUsers -User jsmith +``` + +Description + ----------- +This example adds the user "jsmith" to the group "testUsers" + +### EXAMPLE 2 + +```powershell +Get-JiraGroup 'Project Admins' | Add-JiraGroupMember -User jsmith +``` + +Description + ----------- +This example illustrates the use of the pipeline to add "jsmith" to the +"Project Admins" group in JIRA. + +## PARAMETERS + +### -Group + +Group (or list of groups) to which the user(s) will be added. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: GroupName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -UserName + +Username or user object obtained from Get-JiraUser. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Whether output should be provided after invoking this function. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Group[]] + +Group(s) to which users should be added + +## OUTPUTS + +### [JiraPS.Group] + +If the `-PassThru` parameter is provided, this function will provide a reference to the JIRA group modified. +Otherwise, this function does not provide output. + +## NOTES + +This REST method is still marked Experimental in JIRA's REST API. +That means that there is a high probability this will break in future versions of JIRA. +The function will need to be re-written at that time. + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraGroup](../Get-JiraGroup/) + +[Get-JiraGroupMember](../Get-JiraGroupMember/) + +[Get-JiraUser](../Get-JiraUser/) + +[New-JiraGroup](../New-JiraGroup/) + +[New-JiraUser](../New-JiraUser/) + +[Remove-JiraGroupMember](../Remove-JiraGroupMember/) + +[Remove-JiraIssue](../Remove-JiraIssue/) + +[Set-JiraIssue](../Set-JiraIssue/) diff --git a/docs/commands/Add-JiraIssueAttachment.md b/docs/commands/Add-JiraIssueAttachment.md new file mode 100644 index 00000000..589c70ab --- /dev/null +++ b/docs/commands/Add-JiraIssueAttachment.md @@ -0,0 +1,175 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Add-JiraIssueAttachment/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Add-JiraIssueAttachment/ +--- +# Add-JiraIssueAttachment + +## SYNOPSIS + +Adds a file attachment to an existing Jira Issue + +## SYNTAX + +```powershell +Add-JiraIssueAttachment [-Issue] [-FilePath] [[-Credential] ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function adds an Attachment to an existing issue in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Add-JiraIssueAttachment -FilePath "Test comment" -Issue "TEST-001" +``` +Description + ----------- +This example adds a simple comment to the issue TEST-001. + +### EXAMPLE 2 + +```powershell +Get-JiraIssue "TEST-002" | Add-JiraIssueAttachment -FilePath "Test comment from PowerShell" +``` + +Description + ----------- +This example illustrates pipeline use from Get-JiraIssue to Add-JiraIssueAttachment. + +## PARAMETERS + +### -Issue + +Issue to which to attach the file. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath + +Path of the file to upload and attach + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: InFile, FullName, Path + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Whether output should be provided after invoking this function + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### This function can accept JiraPS.Issue objects via pipeline. + +## OUTPUTS + +### [JiraPS.Attachment] + +This function outputs the results of the attachment add. + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraIssueAttachment](../Get-JiraIssueAttachment/) + +[Remove-JiraIssueAttachment](../Remove-JiraIssueAttachment/) diff --git a/docs/commands/Add-JiraIssueComment.md b/docs/commands/Add-JiraIssueComment.md new file mode 100644 index 00000000..8a893af1 --- /dev/null +++ b/docs/commands/Add-JiraIssueComment.md @@ -0,0 +1,208 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Add-JiraIssueComment/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Add-JiraIssueComment/ +--- +# Add-JiraIssueComment + +## SYNOPSIS + +Adds a comment to an existing JIRA issue + +## SYNTAX + +```powershell +Add-JiraIssueComment [-Comment] [-Issue] [[-VisibleRole] ] + [[-Credential] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function adds a comment to an existing issue in JIRA. +You can optionally set the visibility of the comment (All Users, Developers, or Administrators). + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Add-JiraIssueComment -Comment "Test comment" -Issue "TEST-001" +``` + +Description + ----------- +This example adds a simple comment to the issue TEST-001. + +### EXAMPLE 2 + +```powershell +Get-JiraIssue "TEST-002" | Add-JiraIssueComment "Test comment from PowerShell" +``` + +Description + ----------- +This example illustrates pipeline use from `Get-JiraIssue` to `Add-JiraIssueComment`. + +### EXAMPLE 3 + +```powershell +Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | + Add-JiraIssueComment "This issue has been cancelled per Vice President's orders." +``` + +Description + ----------- +This example illustrates commenting on all projects which match a given JQL query. +It would be best to validate the query first to make sure the query returns the expected issues! + +### EXAMPLE 4 + +```powershell +$comment = Get-Process | Format-Jira +Add-JiraIssueComment $comment -Issue TEST-003 +``` + +Description + ----------- +This example illustrates adding a comment based on other logic to a JIRA issue. +Note the use of `Format-Jira` to convert the output of `Get-Process` into a format that is easily read by users. + +## PARAMETERS + +### -Comment + +Comment that should be added to JIRA. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Issue + +Issue that should be commented upon. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VisibleRole + +Visibility of the comment. +Defines if the comment should be publicly visible, viewable to only developers, or only administrators. + +Allowed values are: + +- `All Users` +- `Developers` +- `Administrators` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: All Users +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### This function can accept JiraPS.Issue objects via pipeline. + +## OUTPUTS + +### [JiraPS.Comment] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraIssue](../Get-JiraIssue/) + +[Get-JiraIssueComment](../Get-JiraIssueComment/) + +[Format-Jira](../Format-Jira/) diff --git a/docs/commands/Add-JiraIssueLink.md b/docs/commands/Add-JiraIssueLink.md new file mode 100644 index 00000000..51acf53d --- /dev/null +++ b/docs/commands/Add-JiraIssueLink.md @@ -0,0 +1,173 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Add-JiraIssueLink/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Add-JiraIssueLink/ +--- +# Add-JiraIssueLink + +## SYNOPSIS + +Adds a link between two Issues on Jira + +## SYNTAX + +```powershell +Add-JiraIssueLink [-Issue] [-IssueLink] [[-Comment] ] + [[-Credential] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Creates a new link of the specified type between two Issue. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +$_issueLink = [PSCustomObject]@{ + outwardIssue = [PSCustomObject]@{key = "TEST-10"} + type = [PSCustomObject]@{name = "Composition"} +} +Add-JiraIssueLink -Issue TEST-01 -IssueLink $_issueLink +``` + +Description + ----------- +Creates a link "is part of" between TEST-01 and TEST-10 + +## PARAMETERS + +### -Issue + +Issue which should be linked. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IssueLink + +Issue Link to be created. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment + +Write a comment to the issue + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue[]] + +The JIRA issue that should be linked +The JIRA issue link that should be used + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraIssue](../Get-JiraIssue/) + +[Get-JiraIssueLink](../Get-JiraIssueLink/) + +[Get-JiraIssueLinkType](../Get-JiraIssueLinkType/) + +[Remove-JiraIssueLink](../Remove-JiraIssueLink/) diff --git a/docs/commands/Add-JiraIssueWatcher.md b/docs/commands/Add-JiraIssueWatcher.md new file mode 100644 index 00000000..0594ee7a --- /dev/null +++ b/docs/commands/Add-JiraIssueWatcher.md @@ -0,0 +1,172 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Add-JiraIssueWatcher/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Add-JiraIssueWatcher/ +--- +# Add-JiraIssueWatcher + +## SYNOPSIS + +Adds a watcher to an existing JIRA issue + +## SYNTAX + +```powershell +Add-JiraIssueWatcher [-Watcher] [-Issue] [[-Credential] ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +This function adds a watcher to an existing issue in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Add-JiraIssueWatcher -Watcher "fred" -Issue "TEST-001" +``` + +Description + ----------- +This example adds a watcher to the issue TEST-001. + +### EXAMPLE 2 + +```powershell +Get-JiraIssue "TEST-002" | Add-JiraIssueWatcher "fred" +``` + +Description + ----------- +This example illustrates pipeline use from `Get-JiraIssue` to `Add-JiraIssueWatcher`. + +### EXAMPLE 3 + +```powershell +Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | + Add-JiraIssueWatcher "fred" +``` + +Description + ----------- +This example illustrates adding watcher on all projects which match a given JQL query. +It would be best to validate the query first to make sure the query returns the expected issues! + +## PARAMETERS + +### -Watcher + +Watcher that should be added to JIRA + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Issue + +Issue that should be watched. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### This function can accept JiraPS.Issue objects via pipeline. + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraIssue](../Get-JiraIssue/) + +[Get-JiraUser](../Get-JiraUser/) + +[Get-JiraIssueWatcher](../Get-JiraIssueWatcher/) + +[Remove-JiraIssueWatcher](../Remove-JiraIssueWatcher/) diff --git a/docs/commands/Add-JiraIssueWorklog.md b/docs/commands/Add-JiraIssueWorklog.md new file mode 100644 index 00000000..2c95512c --- /dev/null +++ b/docs/commands/Add-JiraIssueWorklog.md @@ -0,0 +1,239 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Add-JiraIssueWorklog/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Add-JiraIssueWorklog/ +--- +# Add-JiraIssueWorklog + +## SYNOPSIS + +Adds a worklog item to an existing JIRA issue + +## SYNTAX + +```powershell +Add-JiraIssueWorklog [-Comment] [-Issue] [-TimeSpent] [-DateStarted] + [[-VisibleRole] ] [[-Credential] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function adds a worklog item to an existing issue in JIRA. +You can optionally set the visibility of the item (All Users, Developers, or Administrators). + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Add-JiraIssueWorklog -Comment "Test comment" -Issue "TEST-001" -TimeSpent 60 -DateStarted (Get-Date) +``` + +Description + ----------- +This example adds a simple worklog item to the issue TEST-001. + +### EXAMPLE 2 + +```powershell +Get-JiraIssue "TEST-002" | Add-JiraIssueWorklog "Test worklog item from PowerShell" -TimeSpent 60 -DateStarted (Get-Date) +``` + +Description + ----------- +This example illustrates pipeline use from `Get-JiraIssue` to `Add-JiraIssueWorklog`. + +### EXAMPLE 3 + +```powershell +Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | + Add-JiraIssueWorklog "This issue has been cancelled per Vice President's orders." -TimeSpent 60 -DateStarted (Get-Date) +``` + +Description + ----------- +This example illustrates logging work on all projects which match a given JQL query. +It would be best to validate the query first to make sure the query returns the expected issues! + +### EXAMPLE 4 + +```powershell +$comment = Get-Process | Format-Jira +Add-JiraIssueWorklog $comment -Issue TEST-003 -TimeSpent 60 -DateStarted (Get-Date) +``` + +Description + ----------- +This example illustrates adding a comment based on other logic to a JIRA issue. + +Note the use of `Format-Jira` to convert the output of `Get-Process` into a format that is easily read by users. + +## PARAMETERS + +### -Comment + +Worklog item that should be added to JIRA + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Issue + +Issue to receive the new worklog item. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -TimeSpent + +Time spent to be logged + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DateStarted + +Date/time started to be logged + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -VisibleRole + +Visibility of the comment. +Defines if the comment should be publicly visible, viewable to only developers, or only administrators. + +Allowed values are: + +- `All Users` +- `Developers` +- `Administrators` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: All Users +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### This function can accept JiraPS.Issue objects via pipeline. + +## OUTPUTS + +### [JiraPS.Worklogitem] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraIssue](../Get-JiraIssue/) + +[Format-Jira](../Format-Jira/) diff --git a/docs/commands/Format-Jira.md b/docs/commands/Format-Jira.md new file mode 100644 index 00000000..98b487c0 --- /dev/null +++ b/docs/commands/Format-Jira.md @@ -0,0 +1,107 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Format-Jira/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Format-Jira/ +--- +# Format-Jira + +## SYNOPSIS + +Converts an object into a table formatted according to JIRA's markdown syntax + +## SYNTAX + +```powershell +Format-Jira [-InputObject] [[-Property] ] [] +``` + +## DESCRIPTION + +This function converts a PowerShell object into a table using JIRA's markdown syntax. +This can then be added to a JIRA issue description or comment. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-Process | Format-Jira | Add-JiraIssueComment -Issue TEST-001 +``` + +Description + ----------- +This example illustrates converting the output from `Get-Process` into a JIRA table, which is then added as a comment to issue TEST-001. + +### EXAMPLE 2 + +```powershell +Get-Process chrome | Format-Jira Name,Id,VM +``` + +Description + ----------- +This example obtains all Google Chrome processes, then creates a JIRA table with only the Name,ID, and VM properties of each object. + +## PARAMETERS + +### -InputObject + +Object to format. + +```yaml +Type: PSObject[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Property + +List of properties to display. +If omitted, only the default properties will be shown. + +To display all properties, use `-Property *`. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [System.Object[]] + +accepts any Object via pipeline + +## OUTPUTS + +### [System.String] + +## NOTES + +Like the native `Format-*` cmdlets, this is a destructive operation. + +Remember to "filter left, format right!" + +## RELATED LINKS diff --git a/docs/commands/Get-JiraComponent.md b/docs/commands/Get-JiraComponent.md new file mode 100644 index 00000000..8f3cbe5c --- /dev/null +++ b/docs/commands/Get-JiraComponent.md @@ -0,0 +1,157 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraComponent/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraComponent/ +--- +# Get-JiraComponent + +## SYNOPSIS + +Returns a Component from Jira + +## SYNTAX + +### ByID (Default) + +```powershell +Get-JiraComponent [-ComponentId] [-Credential ] [] +``` + +### ByProject + +```powershell +Get-JiraComponent [-Project] [-Credential ] [] +``` + +## DESCRIPTION + +This function returns information regarding a specified component from Jira. + +Components are specific to a Project. +Therefore, it is not possible to query for Components without a project. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraComponent -Id 10000 +``` + +Description + ----------- +Returns information about the component with ID 10000 + +### EXAMPLE 2 + +```powershell +Get-JiraComponent 20000 -Credential $cred +``` + +Description + ----------- +Returns information about the component with ID 20000 + +### EXAMPLE 3 + +```powershell +Get-JiraProject "Project1" | Get-JiraComponent +``` + +Description + ----------- +Returns information about all components within project 'Project1' + +### EXAMPLE 4 + +```powershell +Get-JiraComponent ABC,DEF +``` + +Description + ----------- +Return information about all components within projects 'ABC' and 'DEF' + +## PARAMETERS + +### -Project + +The ID or Key of the Project to search. + +```yaml +Type: Object[] +Parameter Sets: ByProject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ComponentId + +The ID of the component. + +```yaml +Type: Int32[] +Parameter Sets: ByID +Aliases: Id + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [String[]] / [JiraPS.Component[]] + +Retrieve all Components in a specific project. + +### [Int[]] + +Retrieve specific Components by theirs id. + +## OUTPUTS + +### [JiraPS.Component] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +Remaining operations for `component` have not yet been implemented in the module. + +## RELATED LINKS diff --git a/docs/commands/Get-JiraConfigServer.md b/docs/commands/Get-JiraConfigServer.md new file mode 100644 index 00000000..f337c885 --- /dev/null +++ b/docs/commands/Get-JiraConfigServer.md @@ -0,0 +1,87 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraConfigServer/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraConfigServer/ +--- +# Get-JiraConfigServer + +## SYNOPSIS + +Obtains the configured URL for the JIRA server + +## SYNTAX + +```powershell +Get-JiraConfigServer [[-ConfigFile] ] [] +``` + +## DESCRIPTION + +This function returns the configured URL for the JIRA server that JiraPS should manipulate. + +By default, this is stored in a config.xml file at the module's root path. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraConfigServer +``` + +Description + ----------- +Returns the server URL of the JIRA server configured in the JiraPS config file. + +### EXAMPLE 2 + +```powershell +Get-JiraConfigServer -ConfigFile C:\jiraconfig.xml +``` + +Description + ----------- +Returns the server URL of the JIRA server configured at C:\jiraconfig.xml. + +## PARAMETERS + +### -ConfigFile + +Path to the configuration file, if not the default. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [System.String] + +## NOTES + +Support for multiple configuration files is limited at this point in time, but enhancements are planned for a future update. + + + +## RELATED LINKS + +[about_JiraPS_Authentication](../../about/authentication.html) diff --git a/docs/commands/Get-JiraField.md b/docs/commands/Get-JiraField.md new file mode 100644 index 00000000..56d24128 --- /dev/null +++ b/docs/commands/Get-JiraField.md @@ -0,0 +1,116 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraField/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraField/ +--- +# Get-JiraField + +## SYNOPSIS + +This function returns information about JIRA fields + +## SYNTAX + +### _All (Default) + +```powershell +Get-JiraField [-Credential ] [] +``` + +### _Search + +```powershell +Get-JiraField [-Field] [-Credential ] [] +``` + +## DESCRIPTION + +This function provides information about JIRA fields, or about one field in particular. +This is a good way to identify a field's ID by its name, or vice versa. + +Typically, this information is only needed when identifying what fields are necessary to create or edit issues. +See `Get-JiraIssueCreateMetadata` for more details. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraField +``` + +Description + ----------- +This example returns information about all JIRA fields visible to the current user. + +### EXAMPLE 2 + +```powershell +Get-JiraField "Key" +``` + +Description + ----------- +This example returns information about the Key field. + +## PARAMETERS + +### -Field + +The Field name or ID to search. + +```yaml +Type: String[] +Parameter Sets: _Search +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.Field] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +Remaining operations for `field` have not yet been implemented in the module. + +## RELATED LINKS + +[Get-JiraIssueCreateMetadata](../Get-JiraIssueCreateMetadata/) diff --git a/docs/commands/Get-JiraFilter.md b/docs/commands/Get-JiraFilter.md new file mode 100644 index 00000000..6eca17b8 --- /dev/null +++ b/docs/commands/Get-JiraFilter.md @@ -0,0 +1,136 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraFilter/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraFilter/ +--- +# Get-JiraFilter + +## SYNOPSIS + +Returns information about a filter in JIRA + +## SYNTAX + +### ByFilterID (Default) + +```powershell +Get-JiraFilter [-Id] [-Credential ] [] +``` + +### ByInputObject + +```powershell +Get-JiraFilter -InputObject [-Credential ] [] +``` + +## DESCRIPTION + +This function returns information about a filter in JIRA, including the JQL syntax of the filter, its owner, and sharing status. + +This function is only capable of returning filters by their Filter ID. +This is a limitation of JIRA's REST API. + +The easiest way to obtain the ID of a filter is to load the filter in the "regular" Web view of JIRA, +then copy the ID from the URL of the page. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraFilter -Id 12345 +``` + +Description + ----------- +Gets a reference to filter ID 12345 from JIRA + +### EXAMPLE 2 + +```powershell +$filterObject | Get-JiraFilter +``` + +Description + ----------- +Gets the information of a filter by providing a filter object + +## PARAMETERS + +### -Id + +ID of the filter to search for. + +```yaml +Type: String[] +Parameter Sets: ByFilterID +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Object of the filter to search for. + +```yaml +Type: Object[] +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Filter[]] / [String[]] + +The filter to look up in JIRA. This can be a String (filter ID) or a JiraPS.Filter object. + +## OUTPUTS + +### [JiraPS.Filter] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +Remaining operations for `filter` have not yet been implemented in the module. + +## RELATED LINKS diff --git a/docs/commands/Get-JiraGroup.md b/docs/commands/Get-JiraGroup.md new file mode 100644 index 00000000..46df23ea --- /dev/null +++ b/docs/commands/Get-JiraGroup.md @@ -0,0 +1,111 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraGroup/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraGroup/ +--- +# Get-JiraGroup + +## SYNOPSIS + +Returns a group from Jira + +## SYNTAX + +```powershell +Get-JiraGroup [-GroupName] [[-Credential] ] [] +``` + +## DESCRIPTION + +This function returns information regarding a specified group from JIRA. + +To get the members of a group, use `Get-JiraGroupMember`. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraGroup -GroupName testGroup +``` + +Description + ----------- +Returns information about the group "testGroup" + +### EXAMPLE 2 + +```powershell +Get-JiraGroup -GroupName testGroup | + Get-JiraGroupMember +``` + +Description + ----------- +This example retrieves the members of "testGroup". + +## PARAMETERS + +### -GroupName + +Name of the group to search for. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.Group] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraGroupMember](../Get-JiraGroupMember/) + +[Get-JiraUser](../Get-JiraUser/) + +[New-JiraGroup](../New-JiraGroup/) + +[Remove-JiraGroup](../Remove-JiraGroup/) diff --git a/docs/commands/Get-JiraGroupMember.md b/docs/commands/Get-JiraGroupMember.md new file mode 100644 index 00000000..52cfdb44 --- /dev/null +++ b/docs/commands/Get-JiraGroupMember.md @@ -0,0 +1,160 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraGroupMember/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraGroupMember/ +--- +# Get-JiraGroupMember + +## SYNOPSIS + +Returns members of a given group in JIRA + +## SYNTAX + +```powershell +Get-JiraGroupMember [-Group] [[-StartIndex] ] [[-MaxResults] ] + [[-Credential] ] [] +``` + +## DESCRIPTION + +This function returns members of a provided group in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraGroupMember testGroup +``` + +Description + ----------- +This example returns all members of the JIRA group testGroup. + +### EXAMPLE 2 + +```powershell +Get-JiraGroup 'Developers' | Get-JiraGroupMember +``` + +Description + ----------- +This example illustrates the use of the pipeline to return members of +the Developers group in JIRA. + +## PARAMETERS + +### -Group + +Group object of which to display the members. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -StartIndex + +Index of the first user to return. + +This can be used to "page" through users in a large group or a slow connection. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxResults + +Maximum number of results to return. + +By default, all users will be returned. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Group] + +The group to query for members + +## OUTPUTS + +### [JiraPS.User] + +## NOTES + +By default, this will return all active users who are members of the given group. +For large groups, this can take quite some time. + +To limit the number of group members returned, use the MaxResults parameter. +You can also combine this with the `-StartIndex` parameter to "page" through results. + +This function does not return inactive users. +This appears to be a limitation of JIRA's REST API. + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraGroup](../Get-JiraGroup/) + +[Add-JiraGroupMember](../Add-JiraGroupMember/) + +[New-JiraGroup](../New-JiraGroup/) + +[New-JiraUser](../New-JiraUser/) + +[Remove-JiraGroupMember](../Remove-JiraGroupMember/) diff --git a/docs/commands/Get-JiraIssue.md b/docs/commands/Get-JiraIssue.md new file mode 100644 index 00000000..7d682976 --- /dev/null +++ b/docs/commands/Get-JiraIssue.md @@ -0,0 +1,290 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraIssue/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraIssue/ +--- +# Get-JiraIssue + +## SYNOPSIS + +Returns information about an issue in JIRA. + +## SYNTAX + +### ByIssueKey (Default) + +```powershell +Get-JiraIssue [-Key] [-Credential ] [] +``` + +### ByInputObject + +```powershell +Get-JiraIssue [-InputObject] [-Credential ] [] +``` + +### ByJQL + +```powershell +Get-JiraIssue -Query [-StartIndex ] [-MaxResults ] [-PageSize ] + [-Credential ] [] +``` + +### ByFilter + +```powershell +Get-JiraIssue -Filter [-StartIndex ] [-MaxResults ] [-PageSize ] + [-Credential ] [] +``` + +## DESCRIPTION + +This function retrieves the data of a issue in JIRA. + +This function can be used to directly query JIRA for a specific issue key or internal issue ID. +It can also be used to query JIRA for issues matching a specific criteria using JQL (Jira Query Language). + +> For more details on JQL syntax, see this article from Atlassian: [https://confluence.atlassian.com/display/JIRA/Advanced+Searching](https://confluence.atlassian.com/display/JIRA/Advanced+Searching) + +Output from this function can be piped to various other functions in this module, including `Set-JiraIssue`, `Add-JiraIssueComment`, and `Invoke-JiraIssueTransition`. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraIssue -Key TEST-001 +``` + +Description + ----------- +This example fetches the issue "TEST-001". + +The default `Format-Table` view of a Jira issue only shows the value of "Key", "Summary", "Status" and "Created". +> This can be manipulated with `Format-Table`, `Format-List` and `Select-Object` + +### EXAMPLE 2 + +```powershell +Get-JiraIssue "TEST-002" | Add-JiraIssueComment "Test comment from PowerShell" +``` + +Description + ----------- +This example illustrates pipeline use from `Get-JiraIssue` to `Add-JiraIssueComment`. + +### EXAMPLE 3 + +```powershell +Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' +``` + +Description + ----------- +This example illustrates using the `-Query` parameter and JQL syntax to query Jira for matching issues. + +### EXAMPLE 4 + +```powershell +Get-JiraIssue -InputObject $oldIssue +``` + +Description + ----------- +This example illustrates how to get an update of an issue from an old result of `Get-JiraIssue` stored in $oldIssue. + +### EXAMPLE 5 + +```powershell +Get-JiraFilter -Id 12345 | Get-JiraIssue +``` + +Description + ----------- +This example retrieves all issues that match the criteria in the saved filter with id 12345. + +### EXAMPLE 6 + +```powershell +Get-JiraFilter 12345 | Select-Object * +``` + +Description + ----------- +This prints all fields of the issue to the console. + +## PARAMETERS + +### -Key + +Key of the issue to search for. + +```yaml +Type: String[] +Parameter Sets: ByIssueKey +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Object of an issue to search for. + +```yaml +Type: Object[] +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query + +JQL query for which to search for. + +```yaml +Type: String +Parameter Sets: ByJQL +Aliases: JQL + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter + +Object of an existing JIRA filter from which the results will be returned. + +```yaml +Type: Object +Parameter Sets: ByFilter +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIndex + +Index of the first issue to return. + +This can be used to "page" through issues in a large collection or a slow connection. + +```yaml +Type: Int32 +Parameter Sets: ByJQL, ByFilter +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxResults + +Maximum number of results to return. + +By default, all issues will be returned. + +```yaml +Type: Int32 +Parameter Sets: ByJQL, ByFilter +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize + +How many issues should be returned per call to JIRA. + +This parameter only has effect if `-MaxResults` is not provided or set to 0. + +Normally, you should not need to adjust this parameter, +but if the REST calls take a long time, +try playing with different values here. + +```yaml +Type: Int32 +Parameter Sets: ByJQL, ByFilter +Aliases: + +Required: False +Position: Named +Default value: 50 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] / [String] + +- If a JiraPS.Issue object is passed, this function returns a new reference to the same issue. +- If a String is passed, this function searches for an issue with that issue key or internal ID. +- If an Object is passed, this function invokes its ToString() method and treats it as a String. + +## OUTPUTS + +### [JiraPS.Issue] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[about_JiraPS_CreatingIssues](../../about/creating-issues.html) + +[about_JiraPS_CustomFields](../../about/custom-fields.html) + +[New-JiraIssue](../New-JiraIssue/) diff --git a/docs/commands/Get-JiraIssueAttachment.md b/docs/commands/Get-JiraIssueAttachment.md new file mode 100644 index 00000000..726552db --- /dev/null +++ b/docs/commands/Get-JiraIssueAttachment.md @@ -0,0 +1,139 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraIssueAttachment/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraIssueAttachment/ +--- +# Get-JiraIssueAttachment + +## SYNOPSIS + +Returns attachments of an issue in JIRA. + +## SYNTAX + +```powershell +Get-JiraIssueAttachment [-Issue] [[-FileName] ] [[-Credential] ] + [] +``` + +## DESCRIPTION + +This function obtains attachments from existing issues in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraIssueAttachment -Issue TEST-001 +``` + +Description + ----------- +This example returns all attachments from issue TEST-001. + +### EXAMPLE 2 + +```powershell +Get-JiraIssue TEST-002 | Get-JiraIssueAttachment +``` + +Description + ----------- +This example illustrates use of the pipeline to return all attachments from issue TEST-002. + +### EXAMPLE 3 + +```powershell +Get-JiraIssue TEST-002 | Get-JiraIssueAttachment -FileName "*.png" +``` + +Description + ----------- +Returns all attachments of issue TEST-002 where the filename ends in `.png` + +## PARAMETERS + +### -Issue + +JIRA issue to check for attachments. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FileName + +Name of the file(s) to filter. + +This parameter supports wildcards. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] / [String] + +## OUTPUTS + +### [JiraPS.Attachment] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Add-JiraIssueAttachment](../Add-JiraIssueAttachment/) + +[Get-JiraIssue](../Get-JiraIssue/) + +[Remove-JiraIssueAttachment](../Remove-JiraIssueAttachment/) diff --git a/docs/commands/Get-JiraIssueComment.md b/docs/commands/Get-JiraIssueComment.md new file mode 100644 index 00000000..556e63e9 --- /dev/null +++ b/docs/commands/Get-JiraIssueComment.md @@ -0,0 +1,108 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraIssueComment/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraIssueComment/ +--- +# Get-JiraIssueComment + +## SYNOPSIS + +Returns comments on an issue in JIRA. + +## SYNTAX + +```powershell +Get-JiraIssueComment [-Issue] [[-Credential] ] [] +``` + +## DESCRIPTION + +This function obtains comments from existing issues in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraIssueComment -Key TEST-001 +``` + +Description + ----------- +This example returns all comments posted to issue TEST-001. + +### EXAMPLE 2 + +```powershell +Get-JiraIssue TEST-002 | Get-JiraIssueComment +``` + +Description + ----------- +This example illustrates use of the pipeline to return all comments on issue TEST-002. + +## PARAMETERS + +### -Issue + +JIRA issue to check for comments. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] / [String] + +## OUTPUTS + +### [JiraPS.Comment] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Add-JiraIssueComment](../Add-JiraIssueComment/) + +[Get-JiraIssue](../Get-JiraIssue/) diff --git a/docs/commands/Get-JiraIssueCreateMetadata.md b/docs/commands/Get-JiraIssueCreateMetadata.md new file mode 100644 index 00000000..57f30536 --- /dev/null +++ b/docs/commands/Get-JiraIssueCreateMetadata.md @@ -0,0 +1,128 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraIssueCreateMetadata/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraIssueCreateMetadata/ +--- +# Get-JiraIssueCreateMetadata + +## SYNOPSIS + +Returns metadata required to create an issue in JIRA + +## SYNTAX + +```powershell +Get-JiraIssueCreateMetadata [-Project] [-IssueType] [[-Credential] ] + [] +``` + +## DESCRIPTION + +This function returns metadata required to create an issue in JIRA - the fields that can be defined in the process of creating an issue. +This can be used to identify custom fields in order to pass them to `New-JiraIssue`. + +This function is particularly useful when your JIRA instance includes custom fields that are marked as mandatory. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraIssueCreateMetadata -Project 'TEST' -IssueType 'Bug' +``` + +Description + ----------- +This example returns the fields available when creating an issue of type Bug under project TEST. + +### EXAMPLE 2 + +```powershell +Get-JiraIssueCreateMetadata -Project 'JIRA' -IssueType 'Bug' | ? {$_.Required -eq $true} +``` + +Description + ----------- +This example returns fields available when creating an issue of type Bug under the project Jira. + +It then uses `Where-Object` (aliased by the question mark) to filter only the fields that are required. + +## PARAMETERS + +### -Project + +Project ID or key of the reference issue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssueType + +Issue type ID or name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.Field] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[about_JiraPS_CreatingIssues](../../about/creating-issues.html) + +[Get-JiraField](../Get-JiraField/) + +[New-JiraIssue](../New-JiraIssue/) diff --git a/docs/commands/Get-JiraIssueEditMetadata.md b/docs/commands/Get-JiraIssueEditMetadata.md new file mode 100644 index 00000000..181a0b7b --- /dev/null +++ b/docs/commands/Get-JiraIssueEditMetadata.md @@ -0,0 +1,110 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraIssueEditMetadata/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraIssueEditMetadata/ +--- +# Get-JiraIssueEditMetadata + +## SYNOPSIS + +Returns metadata required to change an issue in JIRA + +## SYNTAX + +```powershell +Get-JiraIssueEditMetadata [-Issue] [[-Credential] ] [] +``` + +## DESCRIPTION + +This function returns metadata required to update an issue in JIRA - the fields that can be defined in the process of updating an issue. +This can be used to identify custom fields in order to pass them to `Set-JiraIssue`. + +This function is particularly useful when your JIRA instance includes custom fields that are marked as mandatory. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraIssueEditMetadata -Issue "TEST-001" +``` + +Description + ----------- +This example returns the fields available when updating the issue "TEST-001". + +### EXAMPLE 2 + +```powershell +Get-JiraIssueEditMetadata -Issue "TEST-001" | ? {$_.Required -eq $true} +``` + +Description + ----------- +This example returns fields available when updating the issue "TEST-001". +It then uses `Where-Object` (aliased by the question mark) to filter only the fields that are required. + +## PARAMETERS + +### -Issue + +Issue id or key of the reference issue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.Field] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[about_JiraPS_UpdatingIssues](../../about/updating-issues.html) + +[Get-JiraField](../Get-JiraField/) + +[Set-JiraIssue](../Set-JiraIssue/) diff --git a/docs/commands/Get-JiraIssueLink.md b/docs/commands/Get-JiraIssueLink.md new file mode 100644 index 00000000..39265303 --- /dev/null +++ b/docs/commands/Get-JiraIssueLink.md @@ -0,0 +1,120 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraIssueLink/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraIssueLink/ +--- +# Get-JiraIssueLink + +## SYNOPSIS + +Returns a specific issueLink from Jira + +## SYNTAX + +```powershell +Get-JiraIssueLink [-Id] [[-Credential] ] [] +``` + +## DESCRIPTION + +This function returns information regarding a specified issueLink from Jira. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraIssueLink 10000 +``` + +Description + ----------- +Returns information about the IssueLink with ID 10000 + +### EXAMPLE 2 + +```powershell +Get-JiraIssueLink -IssueLink 10000 +``` + +Description + ----------- +Returns information about the IssueLink with ID 10000 + +### EXAMPLE 3 + +```powershell +(Get-JiraIssue TEST-01).issuelinks | Get-JiraIssueLink +``` + +Description + ----------- +Returns the information about all IssueLinks in issue TEST-01 + +## PARAMETERS + +### -Id + +The IssueLink ID to search. + +Accepts input from pipeline when the object is of type `JiraPS.IssueLink` + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [Int[]] + +## OUTPUTS + +### [JiraPS.IssueLink] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Add-JiraIssueLink](../Add-JiraIssueLink/) + +[Get-JiraIssueLinkType](../Get-JiraIssueLinkType/) + +[Remove-JiraIssueLink](../Remove-JiraIssueLink/) diff --git a/docs/commands/Get-JiraIssueLinkType.md b/docs/commands/Get-JiraIssueLinkType.md new file mode 100644 index 00000000..8eddc1e6 --- /dev/null +++ b/docs/commands/Get-JiraIssueLinkType.md @@ -0,0 +1,121 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraIssueLinkType/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraIssueLinkType/ +--- +# Get-JiraIssueLinkType + +## SYNOPSIS + +Gets available issue link types + +## SYNTAX + +### _All (Default) + +```powershell +Get-JiraIssueLinkType [-Credential ] [] +``` + +### _Search + +```powershell +Get-JiraIssueLinkType [-LinkType] [-Credential ] [] +``` + +## DESCRIPTION + +This function gets available issueLink types from a JIRA server. +It can also return specific information about a single issueLink type. + +This is a useful function for discovering data about issueLink types in order to create and modify issueLinks on issues. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraIssueLinkType +``` + +Description + ----------- +This example returns all available links from the JIRA server + +### EXAMPLE 2 + +```powershell +Get-JiraIssueLinkType -LinkType 1 +``` + +Description + ----------- +This example returns information about the link type with ID 1. + +## PARAMETERS + +### -LinkType + +The Issue Type name or ID to search. + +```yaml +Type: Object +Parameter Sets: _Search +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [Int[]] + +## OUTPUTS + +### [JiraPS.IssueLinkType] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +Remaining operations for `issuetype` have not yet been implemented in the module. + +## RELATED LINKS + +[Add-JiraIssueLink](../Add-JiraIssueLink/) + +[Get-JiraIssueLink](../Get-JiraIssueLink/) + +[Remove-JiraIssueLink](../Remove-JiraIssueLink/) diff --git a/docs/commands/Get-JiraIssueType.md b/docs/commands/Get-JiraIssueType.md new file mode 100644 index 00000000..eba90694 --- /dev/null +++ b/docs/commands/Get-JiraIssueType.md @@ -0,0 +1,124 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraIssueType/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraIssueType/ +--- +# Get-JiraIssueType + +## SYNOPSIS + +Returns information about the available issue type in JIRA. + +## SYNTAX + +### _All (Default) + +```powershell +Get-JiraIssueType [-Credential ] [] +``` + +### _Search + +```powershell +Get-JiraIssueType [-IssueType] [-Credential ] [] +``` + +## DESCRIPTION + +This function retrieves all the available IssueType on the JIRA server an returns them as `JiraPS.IssueType`. + +This function can restrict the output to a subset of the available IssueTypes if told so. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraIssueType +``` + +Description + ----------- +This example returns all the IssueTypes on the JIRA server. + +### EXAMPLE 2 + +```powershell +Get-JiraIssueType -IssueType "Bug" +``` + +Description + ----------- +This example returns only the IssueType "Bug". + +### EXAMPLE 3 + +```powershell +Get-JiraIssueType -IssueType "Bug","Task","4" +``` + +Description + ----------- +This example return the information about the IssueType named "Bug" and "Task" and with id "4". + +## PARAMETERS + +### -IssueType + +The Issue Type name or ID to search. + +```yaml +Type: String[] +Parameter Sets: _Search +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [Int[]] + +## OUTPUTS + +### [JiraPS.IssueType] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraIssue](../Get-JiraIssue/) diff --git a/docs/commands/Get-JiraIssueWatcher.md b/docs/commands/Get-JiraIssueWatcher.md new file mode 100644 index 00000000..344baad0 --- /dev/null +++ b/docs/commands/Get-JiraIssueWatcher.md @@ -0,0 +1,108 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraIssueWatcher/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraIssueWatcher/ +--- +# Get-JiraIssueWatcher + +## SYNOPSIS + +Returns watchers on an issue in JIRA. + +## SYNTAX + +```powershell +Get-JiraIssueWatcher [-Issue] [[-Credential] ] [] +``` + +## DESCRIPTION + +This function obtains watchers from existing issues in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraIssueWatcher -Key TEST-001 +``` + +Description + ----------- +This example returns all watchers posted to issue TEST-001. + +### EXAMPLE 2 + +```powershell +Get-JiraIssue TEST-002 | Get-JiraIssueWatcher +``` + +Description + ----------- +This example illustrates use of the pipeline to return all watchers on issue TEST-002. + +## PARAMETERS + +### -Issue + +JIRA issue to check for watchers. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] / [String] + +## OUTPUTS + +### : This function outputs all JiraPS.Watchers issues associated with the provided issue. + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Add-JiraIssueWatcher](../Add-JiraIssueWatcher/) + +[Remove-JiraIssueWatcher](../Remove-JiraIssueWatcher/) diff --git a/docs/commands/Get-JiraPriority.md b/docs/commands/Get-JiraPriority.md new file mode 100644 index 00000000..523fa0dc --- /dev/null +++ b/docs/commands/Get-JiraPriority.md @@ -0,0 +1,112 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraPriority/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraPriority/ +--- +# Get-JiraPriority + +## SYNOPSIS + +Returns information about the available priorities in JIRA. + +## SYNTAX + +### _All (Default) + +```powershell +Get-JiraPriority [-Credential ] [] +``` + +### _Search + +```powershell +Get-JiraPriority [-Id] [-Credential ] [] +``` + +## DESCRIPTION + +This function retrieves all the available Priorities on the JIRA server an returns them as `JiraPS.Priority`. + +This function can restrict the output to a subset of the available IssueTypes if told so. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraPriority +``` + +Description + ----------- +This example returns all the IssueTypes on the JIRA server. + +### EXAMPLE 2 + +```powershell +Get-JiraPriority -ID 1 +``` + +Description + ----------- +This example returns only the Priority with ID 1. + +## PARAMETERS + +### -Id + +ID of the priority to get. + +```yaml +Type: Int32[] +Parameter Sets: _Search +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.Priority] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +Remaining operations for `priority` have not yet been implemented in the module. + +## RELATED LINKS diff --git a/docs/commands/Get-JiraProject.md b/docs/commands/Get-JiraProject.md new file mode 100644 index 00000000..fed11d47 --- /dev/null +++ b/docs/commands/Get-JiraProject.md @@ -0,0 +1,125 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraProject/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraProject/ +--- +# Get-JiraProject + +## SYNOPSIS + +Returns a project from Jira + +## SYNTAX + +### _All (Default) + +```powershell +Get-JiraProject [-Credential ] [] +``` + +### _Search + +```powershell +Get-JiraProject [-Project] [-Credential ] [] +``` + +## DESCRIPTION + +This function returns information regarding a specified project from Jira. + +If the Project parameter is not supplied, +it will return information about all projects the given user is authorized to view. + +The `-Project` parameter will accept either a project ID or a project key. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraProject -Project TEST -Credential $cred +``` + +Description + ----------- +Returns information about the project TEST + +### EXAMPLE 2 + +```powershell +Get-JiraProject 2 -Credential $cred +``` + +Description + ----------- +Returns information about the project with ID 2 + +### EXAMPLE 3 + +```powershell +Get-JiraProject +``` + +Description + ----------- +Returns information about all projects the user is authorized to view + +## PARAMETERS + +### -Project + +The Project ID or project key of a project to search. + +```yaml +Type: String[] +Parameter Sets: _Search +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.Project] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +Remaining operations for `project` have not yet been implemented in the module. + +## RELATED LINKS diff --git a/docs/commands/Get-JiraRemoteLink.md b/docs/commands/Get-JiraRemoteLink.md new file mode 100644 index 00000000..2bc5619e --- /dev/null +++ b/docs/commands/Get-JiraRemoteLink.md @@ -0,0 +1,122 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraRemoteLink/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraRemoteLink/ +--- +# Get-JiraRemoteLink + +## SYNOPSIS + +Returns a remote link from a Jira issue + +## SYNTAX + +```powershell +Get-JiraRemoteLink [-Issue] [[-LinkId] ] [[-Credential] ] [] +``` + +## DESCRIPTION + +This function returns information on remote links from a JIRA issue. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraRemoteLink -Issue TEST-001 -Credential $cred +``` + +Description + ----------- +Returns information about all remote links from the issue "TEST-001" + +### EXAMPLE 2 + +```powershell +Get-JiraRemoteLink -Issue TEST-001 -LinkId 100000 -Credential $cred +``` + +Description + ----------- +Returns information about a specific remote link from the issue "TEST-001" + +## PARAMETERS + +### -Issue + +The Issue to search for link. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LinkId + +Get a single link by it's id. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] / [String] + +## OUTPUTS + +### [JiraPS.Link] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Remove-JiraRemoteLink](../Remove-JiraRemoteLink/) diff --git a/docs/commands/Get-JiraServerInformation.md b/docs/commands/Get-JiraServerInformation.md new file mode 100644 index 00000000..a12321d3 --- /dev/null +++ b/docs/commands/Get-JiraServerInformation.md @@ -0,0 +1,74 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraServerInformation/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraServerInformation/ +--- +# Get-JiraServerInformation + +## SYNOPSIS + +This function returns the information about the JIRA Server + +## SYNTAX + +```powershell +Get-JiraServerInformation [[-Credential] ] [] +``` + +## DESCRIPTION + +This functions shows all the information about the JIRA server, such as version, time, etc + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraServerInformation +``` + +Description + ----------- +This example returns information about the JIRA server. + +## PARAMETERS + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.ServerInfo] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS diff --git a/docs/commands/Get-JiraSession.md b/docs/commands/Get-JiraSession.md new file mode 100644 index 00000000..0a5fc083 --- /dev/null +++ b/docs/commands/Get-JiraSession.md @@ -0,0 +1,60 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraSession/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraSession/ +--- +# Get-JiraSession + +## SYNOPSIS + +Obtains a reference to the currently saved JIRA session + +## SYNTAX + +```powershell +Get-JiraSession [] +``` + +## DESCRIPTION + +This function obtains a reference to the currently saved JIRA session. + +This can provide a JIRA session ID, as well as the username used to connect to JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +New-JiraSession -Credential (Get-Credential jiraUsername) +Get-JiraSession +``` + +Description + ----------- +Creates a Jira session for jiraUsername, then obtains a reference to it. + +## PARAMETERS + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.Session] + +## NOTES + +## RELATED LINKS + +[about_JiraPS_Authentication](../../about/authentication.html) + +[New-JiraSession](../New-JiraSession/) diff --git a/docs/commands/Get-JiraUser.md b/docs/commands/Get-JiraUser.md new file mode 100644 index 00000000..7628bfba --- /dev/null +++ b/docs/commands/Get-JiraUser.md @@ -0,0 +1,144 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraUser/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraUser/ +--- +# Get-JiraUser + +## SYNOPSIS + +Returns a user from Jira + +## SYNTAX + +### ByUserName (Default) + +```powershell +Get-JiraUser [-UserName] [-IncludeInactive] [-Credential ] [] +``` + +### ByInputObject + +```powershell +Get-JiraUser [-InputObject] [-IncludeInactive] [-Credential ] [] +``` + +## DESCRIPTION + +This function returns information regarding a specified user from Jira. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraUser -UserName user1 +``` + +Returns information about the user user1 + +### EXAMPLE 2 + +```powershell +Get-ADUser -filter "Name -like 'John*Smith'" | Select-Object -ExpandProperty samAccountName | Get-JiraUser -Credential $cred +``` + +This example searches Active Directory for "John*Smith", then obtains their JIRA user accounts. + +## PARAMETERS + +### -UserName + +Name of the user to search for. + +```yaml +Type: String[] +Parameter Sets: ByUserName +Aliases: User, Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject + +User Object of the user. + +```yaml +Type: Object[] +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeInactive + +Include inactive users in the search + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [String[]] + +Username, name, or e-mail address + +## OUTPUTS + +### [JiraPS.User] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[New-JiraUser](../New-JiraUser/) + +[Remove-JiraUser](../Remove-JiraUser/) diff --git a/docs/commands/Get-JiraVersion.md b/docs/commands/Get-JiraVersion.md new file mode 100644 index 00000000..5c282363 --- /dev/null +++ b/docs/commands/Get-JiraVersion.md @@ -0,0 +1,209 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Get-JiraVersion/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Get-JiraVersion/ +--- +# Get-JiraVersion + +## SYNOPSIS + +This function returns information about a JIRA Project's Version + +## SYNTAX + +### byId (Default) + +```powershell +Get-JiraVersion -Id [-Credential ] [] +``` + +### byInputVersion + +```powershell +Get-JiraVersion [-InputVersion] [-Credential ] [] +``` + +### byProject + +```powershell +Get-JiraVersion [-Project] [-Name ] [-Credential ] [] +``` + +### byInputProject + +```powershell +Get-JiraVersion [-InputProject] [-Name ] [-Credential ] [] +``` + +## DESCRIPTION + +This function provides information about JIRA Version + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraVersion -Project $ProjectKey +``` + +This example returns information about all JIRA Version visible to the current user for the project. + +### EXAMPLE 2 + +```powershell +Get-JiraVersion -Project $ProjectKey -Name '1.0.0.0' +``` + +This example returns the information of a specific Version. + +### EXAMPLE 3 + +```powershell +Get-JiraProject "FOO", "BAR" | Get-JiraVersion -Name "v1.0", "v2.0" +``` + +Get the Version with name "v1.0" and "v2.0" from both projects "FOO" and "BAR" + +### EXAMPLE 4 + +```powershell +Get-JiraVersion -ID '66596' +``` + +This example returns information about all JIRA Version visible to the current user +(or using anonymous access if a JiraPS session has not been defined) for the project. + +## PARAMETERS + +### -Id + +The Version ID + +```yaml +Type: Int32[] +Parameter Sets: byId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputVersion + +A Version object to search for + +```yaml +Type: Object +Parameter Sets: byInputVersion +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Project + +Project key of a project to search + +```yaml +Type: String[] +Parameter Sets: byProject +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputProject + +A Project Object to search + +```yaml +Type: Object +Parameter Sets: byInputProject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name + +Jira Version Name + +```yaml +Type: String[] +Parameter Sets: byProject, byInputProject +Aliases: Versions + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Version] + +### [JiraPS.Project] + +## OUTPUTS + +### [JiraPS.Version] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraProject](../Get-JiraProject/) + +[New-JiraVersion](../New-JiraVersion/) + +[Remove-JiraVersion](../Remove-JiraVersion/) + +[Set-JiraVersion](../Set-JiraVersion/) diff --git a/docs/commands/Invoke-JiraIssueTransition.md b/docs/commands/Invoke-JiraIssueTransition.md new file mode 100644 index 00000000..5bda9311 --- /dev/null +++ b/docs/commands/Invoke-JiraIssueTransition.md @@ -0,0 +1,227 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Invoke-JiraIssueTransition/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Invoke-JiraIssueTransition/ +--- +# Invoke-JiraIssueTransition + +## SYNOPSIS + +Performs an issue transition on a JIRA issue changing it's status + +## SYNTAX + +```powershell +Invoke-JiraIssueTransition [-Issue] [-Transition] [[-Fields] ] + [[-Assignee] ] [[-Comment] ] [[-Credential] ] [] +``` + +## DESCRIPTION + +This function performs an issue transition on a JIRA issue. + +Transitions are defined in JIRA through workflows, +and allow the issue to move from one status to the next. + +For example, the "Start Progress" transition typically moves +an issue from an Open status to an "In Progress" status. + +To identify the transitions that an issue can perform, +use `Get-JiraIssue` and check the Transition property of the issue obj ect returned. +Attempting to perform a transition that does not apply to the issue +(for example, trying to "start progress" on an issue in progress) will result in an exception. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Invoke-JiraIssueTransition -Issue TEST-01 -Transition 11 +``` + +Description + ----------- +Invokes transition ID 11 on issue TEST-01. + +### EXAMPLE 2 + +```powershell +Invoke-JiraIssueTransition -Issue TEST-01 -Transition 11 -Comment 'Transition comment' +``` + +Description + ----------- +Invokes transition ID 11 on issue TEST-01 with a comment. +Requires the comment field to be configured visible for transition. + +### EXAMPLE 3 + +```powershell +Invoke-JiraIssueTransition -Issue TEST-01 -Transition 11 -Assignee 'joe.bloggs' +``` + +Description + ----------- +Invokes transition ID 11 on issue TEST-01 and assigns to user 'Joe Blogs'. + +Requires the assignee field to be configured as visible for transition. + +### EXAMPLE 4 + +```powershell +$transitionFields = @{'customfield_12345' = 'example'} +Invoke-JiraIssueTransition -Issue TEST-01 -Transition 11 -Fields $transitionFields +``` + +Description + ----------- +Invokes transition ID 11 on issue TEST-01 and configures a custom field value. + +Requires fields to be configured as visible for transition. + +### EXAMPLE 5 + +```powershell +$transition = Get-JiraIssue -Issue TEST-01 | Select-Object -ExpandProperty Transition | ? {$_.ResultStatus.Name -eq 'In Progress'} +Invoke-JiraIssueTransition -Issue TEST-01 -Transition $transition +``` + +This example identifies the correct transition based on the result status of +"In Progress" and invokes that transition on issue TEST-01. + +## PARAMETERS + +### -Issue + +The Issue Object or ID to transition. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Transition + +The Transition Object or it's ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields + +Any additional fields that should be updated. + +Fields must be configured to appear on the transition screen to use this parameter. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Assignee + +New assignee of the issue. + +Enter `Unassigned` to remove the assignee of the issue. +Assignee field must be configured to appear on the transition screen to use this parameter. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment + +Comment that should be added to JIRA. + +Comment field must be configured to appear on the transition screen to use this parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] / [String] / [JiraPS.Transition] + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[about_JiraPS_CustomFields](../../about/custom-fields.html) + +[about_JiraPS_UpdatingIssues](../../about/updating-issues.html) + +[Get-JiraIssue](../Get-JiraIssue/) diff --git a/docs/commands/New-JiraGroup.md b/docs/commands/New-JiraGroup.md new file mode 100644 index 00000000..d843383d --- /dev/null +++ b/docs/commands/New-JiraGroup.md @@ -0,0 +1,129 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/New-JiraGroup/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/New-JiraGroup/ +--- +# New-JiraGroup + +## SYNOPSIS + +Creates a new group in JIRA + +## SYNTAX + +```powershell +New-JiraGroup [-GroupName] [[-Credential] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function creates a new group in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +New-JiraGroup -GroupName testGroup +``` + +Description + ----------- +This example creates a new JIRA group named testGroup. + +## PARAMETERS + +### -GroupName + +Name for the new group. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [String] + +## OUTPUTS + +### [JiraPS.Group] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraGroup](../Get-JiraGroup/) + +[Remove-JiraGroup](../Remove-JiraGroup/) diff --git a/docs/commands/New-JiraIssue.md b/docs/commands/New-JiraIssue.md new file mode 100644 index 00000000..1960f47a --- /dev/null +++ b/docs/commands/New-JiraIssue.md @@ -0,0 +1,340 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/New-JiraIssue/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/New-JiraIssue/ +--- +# New-JiraIssue + +## SYNOPSIS + +Creates a new issue in JIRA + +## SYNTAX + +```powershell +New-JiraIssue [-Project] [-IssueType] [-Summary] [[-Priority] ] + [[-Description] ] [[-Reporter] ] [[-Labels] ] [[-Parent] ] + [[-FixVersion] ] [[-Fields] ] [[-Credential] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +This function creates a new issue in JIRA. + +Creating an issue requires a lot of data, and the exact data may be +different from one instance of JIRA to the next. + +To identify what data is required for a given issue type and project, +use the `Get-JiraIssueCreateMetadata` function provided in this module. + +Some JIRA instances may require additional custom fields specific to that instance of JIRA. +In addition to the parameterized fields provided in this function, +the Fields parameter accepts a hashtable of field names/IDs and values. +This allows users to provide custom field data when creating an issue. +Read more about it in [about_JiraPS_CustomFields](../../about/custom-fields.html) + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +New-JiraIssue -Project "TEST" -Type "Bug" -Summary "Test issue" +``` + +Description + ----------- +Creates a new issue in the TEST project. + +This is the simplest way possible to use the command, +given the project only requires these fields as mandatory. + +### EXAMPLE 2 + +```powershell +Get-JiraIssueCreateMetadata -Project TEST -IssueType Bug | ? {$_.Required -eq $true} +New-JiraIssue -Project TEST -IssueType Bug -Priority 1 -Summary 'Test issue from PowerShell' -Description 'This is a test issue created from the JiraPS module in PowerShell.' -Fields @{'Custom Field Name 1'=@{"foo" = "bar"};'customfield_10001'=@('baz');} +``` + +Description + ----------- +This example uses `Get-JiraIssueCreateMetadata` to identify fields required to create an issue in JIRA. +It then creates an issue with the Fields parameter providing a field name and a field ID. + +### EXAMPLE 3 + +```powershell +$parameters = @{ + Project = "TEST" + IssueType = "Bug" + Priority = 1 + Summary = 'Test issue from PowerShell' + Description = 'This is a test issue created from the JiraPS module in PowerShell.' + Fields = @{ + "Custom Field Name 1" = @{"foo" = "bar"} + customfield_10001 = @('baz') + } +} +New-JiraIssue @parameters +``` + +Description + ----------- +This illustrates how to use splatting for the example above. + +Read more about splatting: about_Splatting + +## PARAMETERS + +### -Project + +Project in which to create the issue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IssueType + +Type of the issue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Summary + +Summary of the issue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority + +ID of the Priority the issue shall have. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Long description of the issue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reporter + +User that shall be registered as the reporter. + +If left empty, the currently authenticated user will be used. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Labels + +List of labels which will be added to the issue. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parent + +Parent issue - in case of issues of type "Sub-Tasks". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FixVersion + +Set the FixVersion of the issue. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FixVersions + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields + +Any additional fields. + +See: about_JiraPS_CustomFields + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 11 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.Issue] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[about_JiraPS_CreatingIssues](../../about/creating-issues.html) + +[about_JiraPS_CustomFields](../../about/custom-fields.html) + +[Get-JiraIssueCreateMetadata](../Get-JiraIssueCreateMetadata/) + +[Get-JiraComponent](../Get-JiraComponent/) + +[Get-JiraField](../Get-JiraField/) + +[Get-JiraPriority](../Get-JiraPriority/) + +[Get-JiraProject](../Get-JiraProject/) + +[Get-JiraVersion](../Get-JiraVersion/) diff --git a/docs/commands/New-JiraSession.md b/docs/commands/New-JiraSession.md new file mode 100644 index 00000000..38463c5f --- /dev/null +++ b/docs/commands/New-JiraSession.md @@ -0,0 +1,103 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/New-JiraSession/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/New-JiraSession/ +--- +# New-JiraSession + +## SYNOPSIS + +Creates a persistent JIRA authenticated session which can be used by other JiraPS functions + +## SYNTAX + +```powershell +New-JiraSession [-Credential] [[-Headers] ] [] +``` + +## DESCRIPTION + +This function creates a persistent, +authenticated session in to JIRA which can be used by all other +JiraPS functions instead of explicitly passing parameters. + +This removes the need to use the `-Credential` parameter constantly for each function call. + +You can find more information in [about_JiraPS_Authentication](../../about/authentication.html) + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +New-JiraSession -Credential (Get-Credential jiraUsername) +Get-JiraIssue TEST-01 +``` + +Description + ----------- +Creates a Jira session for jiraUsername. +The following `Get-JiraIssue` is run using the saved session for jiraUsername. + +## PARAMETERS + +### -Credential + +Credentials to use to connect to JIRA. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Headers + +Additional Headers + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: @{} +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [PSCredential] + +## OUTPUTS + +### [JiraPS.Session] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[about_JiraPS_Authentication](../../about/authentication.html) + +[Get-JiraSession](../Get-JiraSession/) diff --git a/docs/commands/New-JiraUser.md b/docs/commands/New-JiraUser.md new file mode 100644 index 00000000..ddf456d1 --- /dev/null +++ b/docs/commands/New-JiraUser.md @@ -0,0 +1,192 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/New-JiraUser/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/New-JiraUser/ +--- +# New-JiraUser + +## SYNOPSIS + +Creates a new user in JIRA + +## SYNTAX + +```powershell +New-JiraUser [-UserName] [-EmailAddress] [[-DisplayName] ] [[-Notify] ] + [[-Credential] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function creates a new user in JIRA. + +By default, the new user will be notified via e-mail. + +The new user's password is also randomly generated. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +New-JiraUser -UserName "testUser" -EmailAddress "testUser@example.com" +``` + +Description + ----------- +This example creates a new JIRA user named testUser, +and sends a notification e-mail. +The user's DisplayName will be set to "testUser" since it is not specified. + +### EXAMPLE 2 + +```powershell +New-JiraUser -UserName "testUser2" -EmailAddress "testUser2@example.com" -DisplayName "Test User 2" +``` + +Description + ----------- +This example illustrates setting a user's display name during user creation. + +## PARAMETERS + +### -UserName + +Name of user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress + +E-mail address of the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Email + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName + +Display name of the user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Notify + +Notify the user by e-mail + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.User] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraUser](../Get-JiraUser/) + +[Remove-JiraUser](../Remove-JiraUser/) diff --git a/docs/commands/New-JiraVersion.md b/docs/commands/New-JiraVersion.md new file mode 100644 index 00000000..c39455c5 --- /dev/null +++ b/docs/commands/New-JiraVersion.md @@ -0,0 +1,276 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/New-JiraVersion/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/New-JiraVersion/ +--- +# New-JiraVersion + +## SYNOPSIS + +Creates a new FixVersion in JIRA + +## SYNTAX + +### byObject (Default) + +```powershell +New-JiraVersion [-InputObject] [-Credential ] [-WhatIf] [-Confirm] [] +``` + +### byParameters + +```powershell +New-JiraVersion [-Name] [-Project] [-Description ] [-Archived ] + [-Released ] [-ReleaseDate ] [-StartDate ] [-Credential ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +This function creates a new FixVersion in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +New-JiraVersion -Name '1.0.0.0' -Project "RD" +``` + +Description + ----------- +This example creates a new JIRA Version named "1.0.0.0" in project "RD". + +### EXAMPLE 2 + +```powershell +$project = Get-JiraProject -Project "RD" +New-JiraVersion -Name '1.0.0.0' -Project $project -ReleaseDate "2000-12-31" +``` + +Description + ----------- +Create a new Version in Project "RD" with a set release date. + +### EXAMPLE 3 + +```powershell +$version = Get-JiraVersion -Name "1.0.0.0" -Project "RD" +$version = $version.Project.Key "TEST" +$version | New-JiraVersion +``` + + +Description + ----------- +This example duplicates the Version named "1.0.0.0" in Project "RD" to Project "TEST". + +## PARAMETERS + +### -InputObject +Version object that should be created on the server. + +```yaml +Type: Object +Parameter Sets: byObject +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name + +Name of the version to create. + +```yaml +Type: String +Parameter Sets: byParameters +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Project + +The Project ID + +```yaml +Type: Object +Parameter Sets: byParameters +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +Description of the version. + +```yaml +Type: String +Parameter Sets: byParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archived + +Create the version as archived. + +```yaml +Type: Boolean +Parameter Sets: byParameters +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Released + +Create the version as released. + +```yaml +Type: Boolean +Parameter Sets: byParameters +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseDate + +Date of the release. + +```yaml +Type: DateTime +Parameter Sets: byParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate + +Date of the release. + +```yaml +Type: DateTime +Parameter Sets: byParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### [JiraPS.Version] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraVersion](../Get-JiraVersion/) + +[Remove-JiraVersion](../Remove-JiraVersion/) + +[Set-JiraVersion](../Set-JiraVersion/) + +[Get-JiraProject](../Get-JiraProject/) diff --git a/docs/commands/Remove-JiraGroup.md b/docs/commands/Remove-JiraGroup.md new file mode 100644 index 00000000..4d2b8117 --- /dev/null +++ b/docs/commands/Remove-JiraGroup.md @@ -0,0 +1,146 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Remove-JiraGroup/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Remove-JiraGroup/ +--- +# Remove-JiraGroup + +## SYNOPSIS + +Removes an existing group from JIRA + +## SYNTAX + +```powershell +Remove-JiraGroup [-Group] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +This function removes an existing group from JIRA. + +> Deleting a group does not delete users from JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-JiraGroup -GroupName testGroup +``` + +Description + ----------- +Removes the JIRA group testGroup + +## PARAMETERS + +### -Group + +Group Object or ID to delete. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: GroupName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppress user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Group[]] + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraGroup](../Get-JiraGroup/) + +[New-JiraGroup](../New-JiraGroup/) diff --git a/docs/commands/Remove-JiraGroupMember.md b/docs/commands/Remove-JiraGroupMember.md new file mode 100644 index 00000000..4c17b785 --- /dev/null +++ b/docs/commands/Remove-JiraGroupMember.md @@ -0,0 +1,207 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Remove-JiraGroupMember/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Remove-JiraGroupMember/ +--- +# Remove-JiraGroupMember + +## SYNOPSIS + +Removes a user from a JIRA group + +## SYNTAX + +```powershell +Remove-JiraGroupMember [-Group] [-User] [[-Credential] ] [-PassThru] + [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function removes a JIRA user from a JIRA group. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-JiraGroupMember -Group testUsers -User jsmith +``` + +Description + ----------- +This example removes the user jsmith from the group testUsers. + +### EXAMPLE 2 + +```powershell +Get-JiraGroup 'Project Admins' | Remove-JiraGroupMember -User jsmith +``` + +Description + ----------- +This example illustrates the use of the pipeline to remove jsmith from the "Project Admins" group in JIRA. + +## PARAMETERS + +### -Group + +Group Object or ID from which to remove the user(s). + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: GroupName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -User + +Username or user object obtained from Get-JiraUser + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: UserName + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Whether output should be provided after invoking this function + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppress user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Group[]] + +Group(s) from which users should be removed + +### [JiraPS.User[]] + +User(s) which to remove + +## OUTPUTS + +### [JiraPS.Group] + +If the `-PassThru` parameter is provided, this function will provide a reference to the JIRA group modified. +Otherwise, this function does not provide output. + +## NOTES + +This REST method is still marked Experimental in JIRA's REST API. +That means that there is a high probability this will break in future versions of JIRA. +The function will need to be re-written at that time. + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Add-JiraGroupMember](../Add-JiraGroupMember/) + +[Get-JiraGroup](../Get-JiraGroup/) + +[Get-JiraGroupMember](../Get-JiraGroupMember/) + +[Get-JiraUser](../Get-JiraUser/) + +[New-JiraGroup](../New-JiraGroup/) diff --git a/docs/commands/Remove-JiraIssueAttachment.md b/docs/commands/Remove-JiraIssueAttachment.md new file mode 100644 index 00000000..479f88ab --- /dev/null +++ b/docs/commands/Remove-JiraIssueAttachment.md @@ -0,0 +1,209 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Remove-JiraIssueAttachment/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Remove-JiraIssueAttachment/ +--- +# Remove-JiraIssueAttachment + +## SYNOPSIS + +Removes an attachment from a JIRA issue + +## SYNTAX + +### byId (Default) + +```powershell +Remove-JiraIssueAttachment [-AttachmentId] [-Credential ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +### byIssue + +```powershell +Remove-JiraIssueAttachment [-Issue] [-FileName ] [-Credential ] [-Force] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function removes an attachment from a JIRA issue. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-JiraIssueAttachment -AttachmentId 10039 +``` + +Description + ----------- +Removes attachment with id of 10039 + +### EXAMPLE 2 + +```powershell +Get-JiraIssueAttachment -Issue FOO-1234 | Remove-JiraIssueAttachment +``` + +Description + ----------- +Removes all attachments from issue FOO-1234 + +### EXAMPLE 3 + +```powershell +Remove-JiraIssueAttachment -Issue FOO-1234 -FileName '*.png' -force +``` + +Description + ----------- +Removes all *.png attachments from Issue FOO-1234 without prompting for confirmation + +## PARAMETERS + +### -AttachmentId + +Id of the Attachment to delete + +```yaml +Type: Int32[] +Parameter Sets: byId +Aliases: Id + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Issue + +Issue from which to delete on or more attachments. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: byIssue +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileName + +Name of the File to delete + +```yaml +Type: String[] +Parameter Sets: byIssue +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppress user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] / [String] / [Int] + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Add-JiraIssueAttachment](../Add-JiraIssueAttachment/) + +[Get-JiraIssue](../Get-JiraIssue/) + +[Get-JiraIssueAttachment](../Get-JiraIssueAttachment/) diff --git a/docs/commands/Remove-JiraIssueLink.md b/docs/commands/Remove-JiraIssueLink.md new file mode 100644 index 00000000..40542339 --- /dev/null +++ b/docs/commands/Remove-JiraIssueLink.md @@ -0,0 +1,142 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Remove-JiraIssueLink/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Remove-JiraIssueLink/ +--- +# Remove-JiraIssueLink + +## SYNOPSIS + +Removes a issue link from a JIRA issue + +## SYNTAX + +```powershell +Remove-JiraIssueLink [-IssueLink] [[-Credential] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +This function removes a issue link from a JIRA issue. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-JiraIssueLink 1234,2345 +``` + +Description + ----------- +Removes two issue links with id 1234 and 2345 + +### EXAMPLE 2 + +```powershell +Get-JiraIssue -Query "project = Project1 AND label = lingering" | Remove-JiraIssueLink +``` + +Description + ----------- +Removes all issue links for all issues in project Project1 and that have a label "lingering" + +## PARAMETERS + +### -IssueLink + +IssueLink to delete + +If a `JiraPS.Issue` is provided, all issueLinks will be deleted. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue[]] / [JiraPS.IssueLink[]] + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Add-JiraIssueLink](../Add-JiraIssueLink/) + +[Get-JiraIssue](../Get-JiraIssue/) + +[Get-JiraIssueLink](../Get-JiraIssueLink/) diff --git a/docs/commands/Remove-JiraIssueWatcher.md b/docs/commands/Remove-JiraIssueWatcher.md new file mode 100644 index 00000000..165d7d72 --- /dev/null +++ b/docs/commands/Remove-JiraIssueWatcher.md @@ -0,0 +1,172 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Remove-JiraIssueWatcher/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Remove-JiraIssueWatcher/ +--- +# Remove-JiraIssueWatcher + +## SYNOPSIS + +Removes a watcher from an existing JIRA issue + +## SYNTAX + +```powershell +Remove-JiraIssueWatcher [-Watcher] [-Issue] [[-Credential] ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +This function removes a watcher from an existing issue in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-JiraIssueWatcher -Watcher "fred" -Issue "TEST-001" +``` + +Description + ----------- +This example removes a watcher from the issue TEST-001. + +### EXAMPLE 2 + +```powershell +Get-JiraIssue "TEST-002" | Remove-JiraIssueWatcher "fred" +``` + +Description + ----------- +This example illustrates pipeline use from Get-JiraIssue to Remove-JiraIssueWatcher. + +### EXAMPLE 3 + +```powershell +Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | Remove-JiraIssueWatcher "fred" +``` + +Description + ----------- +This example illustrates removing watcher on all projects which match a given JQL query. + +It would be best to validate the query first to make sure the query returns the expected issues! + +## PARAMETERS + +### -Watcher + +Watcher that should be removed from JIRA + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Issue + +Issue that should be updated. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Add-JiraIssueWatcher](../Add-JiraIssueWatcher/) + +[Get-JiraIssue](../Get-JiraIssue/) + +[Get-JiraUser](../Get-JiraUser/) + +[Get-JiraIssueWatcher](../Get-JiraIssueWatcher/) diff --git a/docs/commands/Remove-JiraRemoteLink.md b/docs/commands/Remove-JiraRemoteLink.md new file mode 100644 index 00000000..6b8e7889 --- /dev/null +++ b/docs/commands/Remove-JiraRemoteLink.md @@ -0,0 +1,172 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Remove-JiraRemoteLink/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Remove-JiraRemoteLink/ +--- +# Remove-JiraRemoteLink + +## SYNOPSIS + +Removes a remote link from a JIRA issue + +## SYNTAX + +```powershell +Remove-JiraRemoteLink [-Issue] [-LinkId] [[-Credential] ] [-Force] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +This function removes a remote link from a JIRA issue. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-JiraRemoteLink TEST-001 10000, 20000 +``` + +Description + ----------- +Removes two remote link from issue "TEST-001" + +### EXAMPLE 2 + +```powershell +Get-JiraIssue -Query "project = TEST" | Remove-JiraRemoteLink 10000 +``` + +Description + ----------- +Removes a specific remote link from all issues in project "TEST" + +## PARAMETERS + +### -Issue + +Issue from which to delete a remote link. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LinkId + +Id of the remote link to delete. + +```yaml +Type: Int32[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppress user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] / [String] + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraIssue](../Get-JiraIssue/) + +[Get-JiraRemoteLink](../Get-JiraRemoteLink/) diff --git a/docs/commands/Remove-JiraSession.md b/docs/commands/Remove-JiraSession.md new file mode 100644 index 00000000..a408acd1 --- /dev/null +++ b/docs/commands/Remove-JiraSession.md @@ -0,0 +1,100 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Remove-JiraSession/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Remove-JiraSession/ +--- +# Remove-JiraSession + +## SYNOPSIS + +[DEPRECATED] Removes a persistent JIRA authenticated session + +## SYNTAX + +```powershell +Remove-JiraSession [[-Session] ] [] +``` + +## DESCRIPTION + +> This command has currently no functionality + +This function removes a persistent JIRA authenticated session and closes the session for JIRA. +This can be used to "log out" of JIRA once work is complete. + +If called with the Session parameter, this function will attempt to close the provided `JiraPS.Session` object. + +If called with no parameters, this function will close the saved JIRA session in the module's PrivateData. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +New-JiraSession -Credential (Get-Credential jiraUsername) +Get-JiraIssue TEST-01 +Remove-JiraSession +``` + +Description + ----------- +This example creates a JIRA session for jiraUsername, runs Get-JiraIssue, and closes the JIRA session. + +### EXAMPLE 2 + +```powershell +$s = New-JiraSession -Credential (Get-Credential jiraUsername) +Remove-JiraSession $s +``` + +Description + ----------- +This example creates a JIRA session and saves it to a variable, then uses the variable reference to +close the session. + +## PARAMETERS + +### -Session + +A Jira session to be closed. + +If not specified, this function will use a saved session. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Session] + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraSession](../Get-JiraSession/) + +[New-JiraSession](../New-JiraSession/) diff --git a/docs/commands/Remove-JiraUser.md b/docs/commands/Remove-JiraUser.md new file mode 100644 index 00000000..ec947df3 --- /dev/null +++ b/docs/commands/Remove-JiraUser.md @@ -0,0 +1,148 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Remove-JiraUser/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Remove-JiraUser/ +--- +# Remove-JiraUser + +## SYNOPSIS + +Removes an existing user from JIRA + +## SYNTAX + +```powershell +Remove-JiraUser [-User] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +This function removes an existing user from JIRA. + +WARNING: Deleting a JIRA user may cause database integrity problems. +See this article for details: +[https://confluence.atlassian.com/jira/how-do-i-delete-a-user-account-192519.html](https://confluence.atlassian.com/jira/how-do-i-delete-a-user-account-192519.html) + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Remove-JiraUser -UserName testUser +``` + +Description + ----------- +Removes the JIRA user TestUser + +## PARAMETERS + +### -User + +User Object or ID to delete. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: UserName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppress user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.User] / [String] + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[New-JiraUser](../New-JiraUser/) + +[Get-JiraUser](../Get-JiraUser/) diff --git a/docs/commands/Remove-JiraVersion.md b/docs/commands/Remove-JiraVersion.md new file mode 100644 index 00000000..2871b65e --- /dev/null +++ b/docs/commands/Remove-JiraVersion.md @@ -0,0 +1,157 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Remove-JiraVersion/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Remove-JiraVersion/ +--- +# Remove-JiraVersion + +## SYNOPSIS + +This function removes an existing version. + +## SYNTAX + +```powershell +Remove-JiraVersion [-Version] [[-Credential] ] [-Force] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +This function removes an existing version in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraVersion -Name '1.0.0.0' -Project $Project | Remove-JiraVersion +``` + +Description + ----------- +This example removes the Version given. + +### EXAMPLE 2 + +```powershell +Remove-JiraVersion -Version '66596' +``` + +Description + ----------- +This example removes the Version given. + +## PARAMETERS + +### -Version + +Version Object or ID to delete. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +Suppress user confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Version] + +## OUTPUTS + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[New-JiraVersion]() + +[Get-JiraVersion]() + +[Set-JiraVersion]() + diff --git a/docs/commands/Set-JiraConfigServer.md b/docs/commands/Set-JiraConfigServer.md new file mode 100644 index 00000000..d45d67be --- /dev/null +++ b/docs/commands/Set-JiraConfigServer.md @@ -0,0 +1,99 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Set-JiraConfigServer/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Set-JiraConfigServer/ +--- +# Set-JiraConfigServer + +## SYNOPSIS + +Defines the configured URL for the JIRA server + +## SYNTAX + +```powershell +Set-JiraConfigServer [-Server] [[-ConfigFile] ] [] +``` + +## DESCRIPTION + +This function defines the configured URL for the JIRA server that JiraPS should manipulate. + +By default, this is stored in a config.xml file at the module's root path. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Set-JiraConfigServer 'https://jira.example.com:8080' +``` + +Description + ----------- +This example defines the server URL of the JIRA server configured in the JiraPS config file. + +## PARAMETERS + +### -Server + +The base URL of the Jira instance. + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: Uri + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigFile + +Path where the file with the configuration will be stored. + +> This parameter is not yet implemented + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [String] + +## OUTPUTS + +### [System.String] + +## NOTES + +Support for multiple configuration files is limited at this point in time, +but enhancements are planned for the next major release. +This can be tracked in [JiraPS#194](https://github.com/AtlassianPS/JiraPS/issues/194) + +## RELATED LINKS + +[about_JiraPS_Authentication](../../about/authentication/) + +[Get-JiraConfigServer](../Get-JiraConfigServer/) diff --git a/docs/commands/Set-JiraIssue.md b/docs/commands/Set-JiraIssue.md new file mode 100644 index 00000000..4c823643 --- /dev/null +++ b/docs/commands/Set-JiraIssue.md @@ -0,0 +1,343 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Set-JiraIssue/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Set-JiraIssue/ +--- +# Set-JiraIssue + +## SYNOPSIS + +Modifies an existing issue in JIRA + +## SYNTAX + +```powershell +Set-JiraIssue [-Issue] [[-Summary] ] [[-Description] ] [[-FixVersion] ] + [[-Assignee] ] [[-Label] ] [[-Fields] ] [[-AddComment] ] + [[-Credential] ] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function modifies an existing issue in JIRA. +This can include changing the issue's summary or description, or assigning the issue. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Set-JiraIssue -Issue TEST-01 -Summary 'Modified issue summary' -Description 'This issue has been modified by PowerShell' +``` + +Description + ----------- +This example changes the summary and description of the JIRA issue TEST-01. + +### EXAMPLE 2 + +```powershell +$issue = Get-JiraIssue TEST-01 +$issue | Set-JiraIssue -Description "$($issue.Description)\`n\`nEdit: Also foo." +``` + +Description + ----------- +This example appends text to the end of an existing issue description by using +`Get-JiraIssue` to obtain a reference to the current issue and description. + +### EXAMPLE 3 + +```powershell +Set-JiraIssue -Issue TEST-01 -Assignee 'Unassigned' +``` + +Description + ----------- +This example removes the assignee from JIRA issue TEST-01. + +### EXAMPLE 4 + +```powershell +Set-JiraIssue -Issue TEST-01 -Assignee 'joe' -AddComment 'Dear [~joe], please review.' +``` + +Description + ----------- +This example assigns the JIRA Issue TEST-01 to 'joe' and adds a comment at one. + +### EXAMPLE 5 + +```powershell +$parameters = @{ + labels = @("DEPRECATED") + AddComment = "Updated with a script" + Fields = @{ + customfield_10000 = @( + @{ + "value" = "NAME" + } + ) + } +} +Set-JiraIssue @parameters -Issue TEST-001, TEST-002 +``` + +Description + ----------- +This example uses splatting to update "TEST-001" and "TEST-002". + +You can read more about splatting in: about_Splatting + +## PARAMETERS + +### -Issue + +Issue to be changed. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Summary + +New summary of the issue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +New description of the issue. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FixVersion + +Set the FixVersion of the issue, this will overwrite any present FixVersions + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: FixVersions + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Assignee + +New assignee of the issue. + +Use the value `Unassigned` to remove the current assignee of the issue. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Label + +Labels to be set on the issue. + +These will overwrite any existing labels on the issue. + +For more granular control over issue labels, use `Set-JiraIssueLabel`. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Fields + +Any additional fields that should be updated. + +Inspect [about_JiraPS_CustomFields](../../about/custom-fields.html) for more information. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddComment + +Add a comment to the issue along with other changes. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Whether output should be provided after invoking this function. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] / [String] / [Int] + +## OUTPUTS + +### [JiraPS.Issue] + +If the `-PassThru` parameter is provided, +this function will provide a reference to the JIRA issue modified. +Otherwise, this function does not provide output. + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[about_JiraPS_UpdatingIssues](../../about/updating-issues.html) + +[about_JiraPS_CustomFields](../../about/custom-fields.html) + +[Get-JiraIssueEditMetadata](../Get-JiraIssueEditMetadata/) + +[Get-JiraComponent](../Get-JiraComponent/) + +[Get-JiraField](../Get-JiraField/) + +[Get-JiraPriority](../Get-JiraPriority/) + +[Get-JiraProject](../Get-JiraProject/) + +[Get-JiraVersion](../Get-JiraVersion/) + +[Set-JiraIssueLabel](../Set-JiraIssueLabel/) diff --git a/docs/commands/Set-JiraIssueLabel.md b/docs/commands/Set-JiraIssueLabel.md new file mode 100644 index 00000000..a2cc9472 --- /dev/null +++ b/docs/commands/Set-JiraIssueLabel.md @@ -0,0 +1,258 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Set-JiraIssueLabel/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Set-JiraIssueLabel/ +--- +# Set-JiraIssueLabel + +## SYNOPSIS + +Modifies labels on an existing JIRA issue + +## SYNTAX + +### ReplaceLabels (Default) + +```powershell +Set-JiraIssueLabel [-Issue] -Set [-Credential ] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### ModifyLabels + +```powershell +Set-JiraIssueLabel [-Issue] [-Add ] [-Remove ] [-Credential ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### ClearLabels + +```powershell +Set-JiraIssueLabel [-Issue] [-Clear] [-Credential ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +This function modifies labels on an existing JIRA issue. +There are four supported operations on labels: + +- **Add**: appends additional labels to the labels that an issue already has +- **Remove**: Removes labels from an issue's current labels +- **Set**: erases the existing labels on the issue and replaces them with the provided values +- **Clear**: removes all labels from the issue + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Set-JiraIssueLabel -Issue TEST-01 -Set 'fixed' +``` + +Description + ----------- +This example replaces all existing labels on issue TEST-01 with one label, "fixed". + +### EXAMPLE 2 + +```powershell +Get-JiraIssue -Query 'created >= -7d AND reporter in (joeSmith)' | Set-JiraIssueLabel -Add 'enhancement' +``` + +Description + ----------- +This example adds the "enhancement" label to all issues matching the JQL - in this case, +all issues created by user joeSmith in the last 7 days. + +### EXAMPLE 3 + +```powershell +Get-JiraIssue TEST-01 | Set-JiraIssueLabel -Clear +``` + +Description + ----------- +This example removes all labels from the issue TEST-01. + +## PARAMETERS + +### -Issue + +Issue of which the labels should be manipulated. + +Can be a `JiraPS.Issue` object, issue key, or internal issue ID. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: Key + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Set + +List of labels that will be set to the issue. + +Any label that was already assigned to the issue will be removed. + +```yaml +Type: String[] +Parameter Sets: ReplaceLabels +Aliases: Label, Replace + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Add + +Labels to be added in addition to the existing ones. + +```yaml +Type: String[] +Parameter Sets: ModifyLabels +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Remove + +Labels of the issue to be removed. + +```yaml +Type: String[] +Parameter Sets: ModifyLabels +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Clear + +Remove all labels of the issue. + +```yaml +Type: SwitchParameter +Parameter Sets: ClearLabels +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Whether output should be provided after invoking this function. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Issue] + +## OUTPUTS + +### [JiraPS.Issue] + +If the `-PassThru` parameter is provided, this function will provide a reference +to the JIRA issue modified. Otherwise, this function does not provide output. + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraIssue](../Get-JiraIssue/) diff --git a/docs/commands/Set-JiraUser.md b/docs/commands/Set-JiraUser.md new file mode 100644 index 00000000..1a8cff06 --- /dev/null +++ b/docs/commands/Set-JiraUser.md @@ -0,0 +1,224 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Set-JiraUser/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Set-JiraUser/ +--- +# Set-JiraUser + +## SYNOPSIS + +Modifies user properties in JIRA + +## SYNTAX + +### ByNamedParameters (Default) + +```powershell +Set-JiraUser [-User] [-DisplayName ] [-EmailAddress ] [-Credential ] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### ByHashtable + +```powershell +Set-JiraUser [-User] [-Property] [-Credential ] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +This function modifies user properties in JIRA, allowing you to change a user's +e-mail address, display name, and any other properties supported by JIRA's API. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Set-JiraUser -User user1 -EmailAddress user1_new@example.com +``` + +Description + ----------- +Modifies user1's e-mail address to a new value. +The original value is overridden. + +### EXAMPLE 2 + +```powershell +Set-JiraUser -User user2 -Properties @{EmailAddress='user2_new@example.com';DisplayName='User 2'} +``` + +Description + ----------- +This example modifies a user's properties using a hashtable. +This allows updating properties that are not exposed as parameters to this function. + +## PARAMETERS + +### -User + +Username or user object obtained from `Get-JiraUser`. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: UserName + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DisplayName + +Display name to set. + +```yaml +Type: String +Parameter Sets: ByNamedParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress + +E-mail address to set. + +```yaml +Type: String +Parameter Sets: ByNamedParameters +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Property + +Hashtable (dictionary) of additional information to set. + +```yaml +Type: Hashtable +Parameter Sets: ByHashtable +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru + +Whether output should be provided after invoking this function. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.User] + +## OUTPUTS + +### [JiraPS.User] + +If the `-PassThru` parameter is provided, this function will provide a reference +to the JIRA user modified. Otherwise, this function does not provide output. + +## NOTES + +It is currently NOT possible to enable and disable users with this function. +JIRA does not currently provide this ability via their REST API. + +> If you'd like to see this ability added to JIRA and to this module, please vote on Atlassian's site for this issue: [https://jira.atlassian.com/browse/JRA-37294](https://jira.atlassian.com/browse/JRA-37294) + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[New-JiraUser](../New-JiraUser/) + +[Get-JiraUser](../Get-JiraUser/) diff --git a/docs/commands/Set-JiraVersion.md b/docs/commands/Set-JiraVersion.md new file mode 100644 index 00000000..2552ea77 --- /dev/null +++ b/docs/commands/Set-JiraVersion.md @@ -0,0 +1,257 @@ +--- +external help file: JiraPS-help.xml +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/commands/Set-JiraVersion/ +locale: en-US +schema: 2.0.0 +layout: documentation +permalink: /docs/JiraPS/commands/Set-JiraVersion/ +--- +# Set-JiraVersion + +## SYNOPSIS + +Modifies an existing Version in JIRA + +## SYNTAX + +```powershell +Set-JiraVersion [-Version] [[-Name] ] [[-Description] ] [[-Archived] ] + [[-Released] ] [[-ReleaseDate] ] [[-StartDate] ] [[-Project] ] + [[-Credential] ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This function modifies the Version for an existing Project in JIRA. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-JiraVersion -Project $Project -Name "Old-Name" | Set-JiraVersion -Name 'New-Name' +``` + +Description + ----------- +This example assigns the modifies the existing version with a new name 'New-Name'. + +### EXAMPLE 2 + +```powershell +Get-JiraVersion -ID 162401 | Set-JiraVersion -Description 'Descriptive String' +``` + +Description + ----------- +This example assigns the modifies the existing version with a new name 'New-Name'. + +## PARAMETERS + +### -Version + +Version to be changed + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name + +New Name of the Version. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +New Description of the Version. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Archived + +New value for Archived. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Released + +New value for Released. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseDate + +New Date of the release. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate + +New Date of the user release. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Project + +The new Project where this version should be in. + +This can be the ID of the Project, or the Project Object + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Credentials to use to connect to JIRA. +If not specified, this function will use anonymous access. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [JiraPS.Version] + +## OUTPUTS + +### [JiraPS.Version] + +## NOTES + +This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. +See `New-JiraSession` for more details. +If neither are supplied, this function will run with anonymous access to JIRA. + +## RELATED LINKS + +[Get-JiraVersion](../Get-JiraVersion/) + +[New-JiraVersion](../New-JiraVersion/) + +[Set-JiraVersion](../Set-JiraVersion/) diff --git a/docs/commands/about_JiraPS.md b/docs/commands/about_JiraPS.md new file mode 100644 index 00000000..fabb3d40 --- /dev/null +++ b/docs/commands/about_JiraPS.md @@ -0,0 +1,117 @@ +--- +Module Name: JiraPS +online version: https://atlassianps.org/docs/JiraPS/ +locale: en-US +layout: documentation +permalink: /docs/JiraPS/ +hide: true +--- +# JiraPS + +## about_JiraPS + +# SHORT DESCRIPTION + +JiraPS is a PowerShell module to interact with Atlassian JIRA via a REST API, while maintaining a consistent PowerShell look and feel. + +# LONG DESCRIPTION + +Jira is an issuetracker from Atlassian. +JiraPS is a Powershell implementation to interact with it's API. + +JiraPS can be used by any user. +The Jira server will check if the authenticated user has the necessary permissions to perform the action. +This allows JiraPS to be used by system administrators (eg: to create new Users), project administrators (eg: to create new Versions) and users (eg: to create or view an issue). + +## GETTING STARTED + +```powershell +# Tell the module what is the server's address +Set-JiraConfigServer -Server "https://jira.server.com" + +# Get the user credentials with which to authenticate +$cred = Get-Credential + +# Get the date from the issue "PR-123" +Get-JiraIssue -Issue "PR-123" -Credential $cred +``` + +JiraPS uses the information provided by `Set-JiraConfigServer` to resolve what server to connect to. +(`Get-JiraConfigServer` can be used to inspect what server is currently being used). + +Every command which needs to authenticate with the server has a parameter `-Credential`. +JiraPS also allows for creating a session with the server with `New-JiraSession`. + +## DISCOVERING YOUR ENVIRONMENT + +Finding all projects you have access to: +```powershell +Get-JiraProject +``` + +Get all issues in a project: +```powershell +Get-JiraIssue -Query "project = CS" +``` + +See all available information of an issue: +```powershell +Get-JiraIssue "CS-15" | Format-List * +``` + +> The view of an issue is minimized so that a table-view is easier to read. +> There are a few options to get to see all the properties of an issue. +> Such as the example above. + +# EXAMPLES + +1. Creating issues from a CSV file + +Given a CSV file which looks something like this: + +```csv +project,summary,description,assignee +CS,Update Server Config, The config of server "srv1" must be updated, admin +CS,Delete temporary files,, admin +``` + +Issues can be created for each for the entries above with JiraPS like this: + +```powershell +Import-CSV "./data.csv" | Foreach { New-JiraIssue -Project $_.project -Summary $_.summary -Description $_.description -Assignee $_.assignee } +``` + +2. Set the "fixVersions" of multiple issues at once + +```powershell +# Get all versions from the project +$version = Get-JiraVersion -Project TV | + # Filter by part of the name + Where {$_.Name -like "1.3"} + +# Get all issues we need +Get-JiraIssue -Query 'project = TV AND label = "ReadyForRelease' | + # Update each issue + Set-JiraIssue -FixVersion $version.Name +``` + +# NOTE + +This project is run by the volunteer organization AtlassianPS. +We are always interested in hearing from new users! +Find us on GitHub or Slack, and let us know what you think. + +# SEE ALSO + +[JiraPS on Github](https://github.com/AtlassianPS/JiraPS) + +[Jira's REST API documentation](https://developer.atlassian.com/cloud/jira/platform/rest/) + +[AtlassianPS org](https://atlassianps.org) + +[AtlassianPS Slack team](https://atlassianps.org/slack) + +# KEYWORDS + +- Jira +- Atlassian diff --git a/docs/commands/about_JiraPS_Authentication.md b/docs/commands/about_JiraPS_Authentication.md new file mode 100644 index 00000000..11781b97 --- /dev/null +++ b/docs/commands/about_JiraPS_Authentication.md @@ -0,0 +1,64 @@ +--- +locale: en-US +layout: documentation +online version: https://atlassianps.org/docs/JiraPS/about/authentication.html +Module Name: JiraPS +permalink: /docs/JiraPS/about/authentication.html +--- +# Authentication + +## about_JiraPS_Authentication + +# SHORT DESCRIPTION + +In order to authenticate with the Jira server, the user can provide the credentials with each command or create a session. + +# LONG DESCRIPTION + +At present, there are two main methods of authenticating to Jira: + +* HTTP basic authentication +* session-based authentication, which uses HTTP basic authentication once and preserves a session cookie. + +> Be sure to set JIRA up to use HTTPS with a valid SSL certificate if you are concerned about security! + +## HTTP Basic + +Each JiraPS function that queries a Jira instance provides a `-Credential` parameter. Simply pass your Jira credentials to this parameter. + +```powershell +$cred = Get-Credential 'powershell' +Get-JiraIssue TEST-01 -Credential $cred +``` + +> HTTP basic authentication is not a secure form of authentication. It uses a Base64-encoded String of the format "username:password", and passes this string in clear text to Jira. Because decrypting this string and obtaining the username and password is trivial, the use of HTTPS is critical in any system that needs to remain secure. + +## Sessions + +Jira sessions still require HTTP Basic Authentication once to create the connection. +But in this case a persistent session is saved as a `WebRequestSession`. This is Powershell's way of reusing the data provided with the first call. + +> Previously Jira allowed for the authentication to use a session token. This token did not contain the username and password. +> But unfortunately, this API can no longer be used in combination with this module. + +To create a Jira session, you can use the New-JiraSession function: + +```powershell +$cred = Get-Credential 'powershell' +New-JiraSession -Credential $cred +``` + +Once you've created this session, you're done! You don't need to specify it when running other commands - JiraPS will manage this session internally. + +The session is stored in the module's runtime. +This means that it will not be available in a new Powershell session or if the module is reloaded. + +## What About OAuth? + +Jira does support use of OAuth, but JiraPS does not yet. +This is a to-do item. + +# SEE ALSO + +- [Wikipedia's "Basic Access Authentication"](https://en.wikipedia.org/wiki/Basic_access_authentication) +- [Implement OAuth for JiraPS](https://github.com/AtlassianPS/JiraPS/issues/101) diff --git a/docs/commands/about_JiraPS_CreatingIssues.md b/docs/commands/about_JiraPS_CreatingIssues.md new file mode 100644 index 00000000..a23376fb --- /dev/null +++ b/docs/commands/about_JiraPS_CreatingIssues.md @@ -0,0 +1,79 @@ +--- +locale: en-US +layout: documentation +online version: https://atlassianps.org/docs/JiraPS/about/creating-issues.html +Module Name: JiraPS +permalink: /docs/JiraPS/about/creating-issues.html +--- +# Creating Issues + +## about_JiraPS_CreatingIssues + +# SHORT DESCRIPTION + +Each project and issue type has different requirements. +This article shows how to know what is mandatory when creating a new issue. + +# LONG DESCRIPTION + +In order to create a new issue in Jira, you need to provide a certain amount of information about the issue. In the Web interface, you encounter this all the time when you hit the "Create Issue" button. + +To create an issue using JiraPS, you need to provide this information as well. Before you can provide the needed information to create an issue, though, you'll need to know what information your Jira instance requires! This can be dramatically different from one Jira instance to the next, and even from one project to another. + +## Identifying "Create" Metadata + +JiraPS includes a command to make discovering this metadata as simple as possible. You will need to provide both a project and an issue type to this function, because each project and issue type can be configured to accept or require different fields when creating issues. + +```powershell +Get-JiraIssueCreateMetadata -Project TEST -IssueType Task +``` + +There are quite a lot of fields that we can provide when we create a new issue! + +This function returns any fields that we can provide when creating a new issue. Not all of these fields are required, though. We can use PowerShell's `Where-Object` cmdlet to filter for only the required fields: + +```powershell +Get-JiraIssueCreateMetadata -Project TEST -IssueType Task | ? {$_.Required -eq $true} +``` + +## Creating An Issue + +Now that we know what fields we need to provide our Jira instance, let's create an issue! + +```powershell +New-JiraIssue -Project TEST -IssueType Task -Reporter 'powershell' -Summary 'Test issue from PowerShell' -Credential $myJiraCreds +``` + +This might be all the information we would need to pass `New-JiraIssue` to create a new Jira issue. We can do much more, though: + +```powershell +$parameters = @{ + Project = TEST + IssueType = Task + Reporter = 'powershell' + Summary = 'Test issue from PowerShell' + Description = "This is a sample issue created by $env:USERNAME on $env:COMPUTERNAME." + Labels = 'Test','Fake' + Credential = $myJiraCreds +} +New-JiraIssue @parameters +``` + +## Additional Fields + +In most Jira instances, the default fields are not the only fields necessary when creating an issue. Most organizations have additional information they track in Jira through the use of custom issue fields. + +`New-JiraIssue` provides the `-Fields` parameter for working with these custom fields: + +```powershell +New-JiraIssue -Fields @{ + 'customfield_10001'='foo' + # Other New-JiraIssue parameters +} +``` + +For more information on the `-Fields` parameter, see the [custom fields](custom-fields.html) page. + +# NOTE + +You don't need to pass your credentials to Jira every time you run `New-JiraIssue`. See the [authentication](authentication.html) page for details. diff --git a/docs/commands/about_JiraPS_CustomFields.md b/docs/commands/about_JiraPS_CustomFields.md new file mode 100644 index 00000000..ae4a79e2 --- /dev/null +++ b/docs/commands/about_JiraPS_CustomFields.md @@ -0,0 +1,289 @@ +--- +locale: en-US +layout: documentation +online version: https://atlassianps.org/docs/JiraPS/about/custom-fields.html +Module Name: JiraPS +permalink: /docs/JiraPS/about/custom-fields.html +--- +# Custom Fields + +## about_JiraPS_CustomFields + +# SHORT DESCRIPTION + +Jira has fields of all possible types. Strings, text boxes, numbers, dropdown menus, lists, aso. + +This article explains how to pass the desired value for each of them. + +# LONG DESCRIPTION + +Many of JiraPS's functions contain convenience parameters for issue fields that are commonly used. These parameters take care of translating PowerShell to the correct JSON format when working with Jira's API. + +However, not every standard Jira field is implemented via a parameter, and most Jira instances also contain custom fields to allow your organization to tailor its Jira instance to your own requirements. To allow JiraPS to work with fields that do not have named parameters, these functions support a generic `-Fields` parameter. + +## Using -Fields + +Basically, `-Fields` uses a hashtable that looks something like this: + +```powerShell + $fields = @{ + fieldName = @{ + value = 'New Value' + } + fieldID = @{ + id = 'ID of new value or item' + } + } + + Set-JiraIssue -Fields $fields +``` + +> This isn't a super easy syntax - and the module authors are always open to ideas for ways to improve this. + +There are two easy ways to know more about a specific field: + +- use the `Get-JiraField` function. This can tell you a lot about what to pass in the Fields hashtable. +- use the `Get-JiraIssue | Format-List *` function on an issue that has the value you are looking for. + +### Some Known Field Formats + +Here are some notes on specific fields that have come up in the past. + +#### Text field + +A text field is a single line of text that requires the value to be a string. + +Examples are: + +- Summary +```powershell +$fields = @{ + summary = "This is an example" +} +``` + +#### Text Area + +A text field with multiple lines of text that requires the value to be a string. + +Examples are: + +- Description +```powershell +$fields = @{ + description = @" + This is an example + with multiple lines of text +"@ # this uses the here-string to pass a multiline value +} +``` + +#### Number + +A number field requires the value to be an Integer. + +```powershell +$fields = @{ + customfield_11444 = 123 +} +``` + +#### Array + +A custom field that is an array of strings. + +Examples are: + +- Labels +```powershell +$fields = @{ + labels = @( "nameOfTheLabel" ) +} +``` + +#### Single-select + +A custom field that allows you to select a single value from a defined list of values. +You can address them by 'value' or by 'id'. + +```powershell +$fields = @{ + customfield_11449 = { value = "option3" } + # or: + customfield_11449 = { id = 10112 } +} +``` + +#### Multi-select + +Multi-value fields require the value to be an array, even if you're only defining one value. + +Examples are: + +- Component/s +```powerShell +$fields = @{ + components = @( + @{ name = 'Component 1' } + ) +} +``` + +#### Date Picker + +A date is passed as a string in the 'YYYY-MM-DD' format. + +Examples are: + +- DueDate +```powershell +$fields = @{ + duedate = "2017-12-31" +} +``` + +#### DateTime Picker + +A custom field that is a datetime in ISO 8601 `YYYY-MM-DDThh:mm:ss.sTZD` format. + +```powershell +$fields = @{ + customfield_11442 = "2015-11-18T14:39:00.000+1100" +} +# or (the automated way of using a [DateTime] object): +$date = Get-Date +$fields = @{ + customfield_11442 = $date.ToString("o") -replace "\.(\d{3})\d*([\+\-]\d{2}):", ".`$1`$2" +} +``` + +> The "automated way of using a [DateTime] object" mentioned above is needed, as Powershell's `Get-Date -format "o"` differs from what Jira supports: +> PoSh: `2015-11-18T14:39:00.0000000+11:00` +> Jira: `2015-11-18T14:39:00.000+1100` + +#### Checkbox + +A custom field that allows you to select a multiple values from a defined list of values. +You can address them by 'value' or by 'id'. + +```powershell +$fields = @{ + customfield_11440 = @( + @{ value = "Text of the first checkbox" } + @{ value = "Text of the third checkbox" } + ) + # or: + customfield_11440 = @( + @{ id = 10112} # id of the first checkbox + @{ id = 10114} # id of the third checkbox + ) +} +``` + +#### Radio Button + +A custom field that allows you to select a single value from a defined list of values. +You can address them by ‘value’ or by ‘id’. + +```powershell +$fields = @{ + customfield_11445 = @{ "value" = "Text of the option" } + # or: + customfield_11445 = @{ "id" = 10112 } # id of the option +} +``` + +#### User Picker + +A custom field that allows a single user to be selected. +The user is identifies by the username. + +```powershell +$fields = @{ + customfield_11453 = @{ name = "tommytomtomahawk" } +} +``` + +#### Multi-User Picker + +A custom field that allows multiple users to be selected. +The user is identifies by the username. + +```powershell +$fields = @{ + customfield_11458 = @( + @{ name = "inigomontoya" } + @{ name = "tommytomtomahawk" } + ) +} +``` + +#### Cascading Picker + +A custom field that allows you to select a multiple values from a defined list of values. +You can address them by 'value' or by 'id'. + +```powershell +$fields = @{ + customfield_11447 = @{ + value = "parent_option1" + child = @{ + value = "p1_child1" + } + } + # or: + customfield_11447 = @{ + id = 10112 + child = @{ + id = 10115 + } + } +} +``` + +### Finding Allowed Values + +Use `Get-JiraField` and look for the AllowedValues property. This will give you both an ID and a value for each "item" your field is allowed to be. + +```powershell +(Get-JiraField "Urgency").AllowedValues +``` + +Then, use this syntax described above. + +# EXAMPLES + +The following extensive example contains several types of custom fields as input for a new Jira issue. + +```powershell +$fields = @{ + project = "TV" + issuetype = "bug" + summary = "Important Issue" + description = "This Issue is *very* important\n\n really!?" + Assignee = "admin" + Reporter = "admin" + Priority = 1 + Fields = @{ + labels = @("important", "notreally") + fixVersion = @( + @{ name = "Release 1.1"} + ) + customfield_10001 = @{ name = "item from a dropdown" } + duedate = "2020-01-01" + } +} + +``` + +# NOTE + +If you run into any additional fields that you'd like to see documented, feel free to let me know in a GitHub issue - or submit a PR to this page with the field! + +# SEE ALSO + +[Jira REST Api - Field input formats](https://developer.atlassian.com/server/jira/platform/rest-apis/#field-input-formats) + +# KEYWORDS + +- customfield diff --git a/docs/commands/about_JiraPS_UpdatingIssues.md b/docs/commands/about_JiraPS_UpdatingIssues.md new file mode 100644 index 00000000..1da804ee --- /dev/null +++ b/docs/commands/about_JiraPS_UpdatingIssues.md @@ -0,0 +1,124 @@ +--- +locale: en-US +layout: documentation +online version: https://atlassianps.org/docs/JiraPS/about/updating-issues.html +Module Name: JiraPS +permalink: /docs/JiraPS/about/updating-issues.html +--- +# Updating Issues + +## about_JiraPS_UpdatingIssues + +# SHORT DESCRIPTION + +This page explains the mechanics for updating a Jira issue. + +# LONG DESCRIPTION + +Jira issues can be updated in 3 different ways: + +- **Editing Issues**: change the value of fields (eg: changing the assignee) +- **Adding Comments** +- **Issue Transitions**: Moving the issue to a following status (eg: moving the issue to "In Work") + +## Editing Issues + +Editing issues is done with the `Set-JiraIssue` function. + +```powershell +# Assign an issue +Set-JiraIssue TEST-1 -Assignee 'bob' + +# Get the issue's existing summary and add a tag +$issue = Get-JiraIssue TEST-1 +$issue | Set-JiraIssue -Summary "$($issue.Summary) (Modified by PowerShell)" + +# Change the issue's summary and add a comment for that change +$issue | Set-JiraIssue -Summary "New Summary" -AddComment "Changed summary for testing" +``` + +If the field you want to change does not have a named parameter, `Set-JiraIssue` also supports changing arbitrary fields using the `-Fields` parameter. +For more information on this parameter, see the [custom_fields](https://atlassianps.org/docs/JiraPS/About/custom-fields.html) page. + +### Labels + +You can set labels on an issue using `Set-JiraIssue`'s `-Label` parameter. +Using this function will overwrite any existing labels on the issue. + +```powershell +Get-JiraIssue TEST-1 | Set-JiraIssue -Label 'Funny','Testing' +``` + +For better control over labels, use `Set-JiraIssueLabel`. +This provides more granular control over the labels in an issue using four parameters: + +- **Add** adds labels to an issue without modifying any existing labels. +- **Remove** removes specific labels from an issue. +- **Set** overwrites all labels with any labels passed to this parameter. +- **Clear** removes all labels from the issue. + +The `-Add` and `-Remove` parameters can be used together; `-Set` and `-Clear` must be used individually. + +```powershell +$issue = Get-JiraIssue TEST-1 + +# Overwrite all labels with these two +$issue | Set-JiraIssueLabel -Set 'Funny','Test' + +# Add another label and remove the Funny label - after this, the +# issue will have 'Test' and 'Serious' +$issue | Set-JiraIssueLabel -Add 'Serious' -Remove 'Funny' + +# Remove ALL the labels! +$issue | Set-JiraIssueLabel -Clear +``` + +## Adding Comments + +`Add-JiraIssueComment` is your friend here. + +```powershell +Add-JiraIssueComment -Issue TEST-1 -Comment "Test comment from PowerShell" +``` + +You can also use `Format-Jira` to convert a PowerShell object into a Jira table. + +```powershell +$commentText = Get-Process powershell | Format-Jira +Get-JiraIssue TEST-1 | Add-JiraIssueComment "Current PowerShell processes:\n$commentText" +``` + +> Like other `Format-*` commands, `Format-Jira` is a destructive operation for data in the pipeline. +> Remember to "filter left, format right!" + +Comments can also be added while changing other fields of issues, e.g. the assignee: + +```powershell +Set-JiraIssue -Issue TEST-1 -Assignee "John" -Addcomment "Dear mr. Doe, please review this issue.Thx" +``` + +## Issue Transitions + +Closing an issue, reopening an issue, or changing an issue to a pending state are all examples of what Jira calls "issue transitions." +The transitions an issue can perform depend on its current status and the Jira workflow set up for its project. + +First, check the transitions an issue can currently perform: + +```powershell +(Get-JiraIssue TEST-1).Transition +``` + +Once you have a list of transitions, use `Invoke-JiraIssueTransition` with the ID of the transition to perform: + +```powershell +Get-JiraIssue TEST-1 | Invoke-JiraIssueTransition -Transition 11 +``` + +> For more information on configuring transitions in JIRA, see Atlassian's article on [JIRA Workflows](https://confluence.atlassian.com/adminjiraserver072/working-with-workflows-828787890.html). + +# KEYWORDS + +- workflow +- comments +- update +- transition diff --git a/docs/commands/index.md b/docs/commands/index.md new file mode 100644 index 00000000..e00db61e --- /dev/null +++ b/docs/commands/index.md @@ -0,0 +1,7 @@ +--- +layout: documentation +permalink: /docs/JiraPS/commands/ +hide: true +--- + +{{ site.html_pages }} From 70bcfda9818860efaf4380c9e8b6054f3a23584b Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Mon, 16 Apr 2018 16:17:48 +0200 Subject: [PATCH 3/7] Moved files to new structure --- docs/{commands => en-US}/about_JiraPS.md | 0 docs/{commands => en-US}/about_JiraPS_Authentication.md | 0 docs/{commands => en-US}/about_JiraPS_CreatingIssues.md | 0 docs/{commands => en-US}/about_JiraPS_CustomFields.md | 0 docs/{commands => en-US}/about_JiraPS_UpdatingIssues.md | 0 docs/{ => en-US}/commands/Add-JiraGroupMember.md | 0 docs/{ => en-US}/commands/Add-JiraIssueAttachment.md | 0 docs/{ => en-US}/commands/Add-JiraIssueComment.md | 0 docs/{ => en-US}/commands/Add-JiraIssueLink.md | 0 docs/{ => en-US}/commands/Add-JiraIssueWatcher.md | 0 docs/{ => en-US}/commands/Add-JiraIssueWorklog.md | 0 docs/{ => en-US}/commands/Format-Jira.md | 0 docs/{ => en-US}/commands/Get-JiraComponent.md | 0 docs/{ => en-US}/commands/Get-JiraConfigServer.md | 0 docs/{ => en-US}/commands/Get-JiraField.md | 0 docs/{ => en-US}/commands/Get-JiraFilter.md | 0 docs/{ => en-US}/commands/Get-JiraGroup.md | 0 docs/{ => en-US}/commands/Get-JiraGroupMember.md | 0 docs/{ => en-US}/commands/Get-JiraIssue.md | 0 docs/{ => en-US}/commands/Get-JiraIssueAttachment.md | 0 docs/{ => en-US}/commands/Get-JiraIssueComment.md | 0 docs/{ => en-US}/commands/Get-JiraIssueCreateMetadata.md | 0 docs/{ => en-US}/commands/Get-JiraIssueEditMetadata.md | 0 docs/{ => en-US}/commands/Get-JiraIssueLink.md | 0 docs/{ => en-US}/commands/Get-JiraIssueLinkType.md | 0 docs/{ => en-US}/commands/Get-JiraIssueType.md | 0 docs/{ => en-US}/commands/Get-JiraIssueWatcher.md | 0 docs/{ => en-US}/commands/Get-JiraPriority.md | 0 docs/{ => en-US}/commands/Get-JiraProject.md | 0 docs/{ => en-US}/commands/Get-JiraRemoteLink.md | 0 docs/{ => en-US}/commands/Get-JiraServerInformation.md | 0 docs/{ => en-US}/commands/Get-JiraSession.md | 0 docs/{ => en-US}/commands/Get-JiraUser.md | 0 docs/{ => en-US}/commands/Get-JiraVersion.md | 0 docs/{ => en-US}/commands/Invoke-JiraIssueTransition.md | 0 docs/{ => en-US}/commands/New-JiraGroup.md | 0 docs/{ => en-US}/commands/New-JiraIssue.md | 0 docs/{ => en-US}/commands/New-JiraSession.md | 0 docs/{ => en-US}/commands/New-JiraUser.md | 0 docs/{ => en-US}/commands/New-JiraVersion.md | 0 docs/{ => en-US}/commands/Remove-JiraGroup.md | 0 docs/{ => en-US}/commands/Remove-JiraGroupMember.md | 0 docs/{ => en-US}/commands/Remove-JiraIssueAttachment.md | 0 docs/{ => en-US}/commands/Remove-JiraIssueLink.md | 0 docs/{ => en-US}/commands/Remove-JiraIssueWatcher.md | 0 docs/{ => en-US}/commands/Remove-JiraRemoteLink.md | 0 docs/{ => en-US}/commands/Remove-JiraSession.md | 0 docs/{ => en-US}/commands/Remove-JiraUser.md | 0 docs/{ => en-US}/commands/Remove-JiraVersion.md | 0 docs/{ => en-US}/commands/Set-JiraConfigServer.md | 0 docs/{ => en-US}/commands/Set-JiraIssue.md | 0 docs/{ => en-US}/commands/Set-JiraIssueLabel.md | 0 docs/{ => en-US}/commands/Set-JiraUser.md | 0 docs/{ => en-US}/commands/Set-JiraVersion.md | 0 docs/{ => en-US}/commands/index.md | 0 55 files changed, 0 insertions(+), 0 deletions(-) rename docs/{commands => en-US}/about_JiraPS.md (100%) rename docs/{commands => en-US}/about_JiraPS_Authentication.md (100%) rename docs/{commands => en-US}/about_JiraPS_CreatingIssues.md (100%) rename docs/{commands => en-US}/about_JiraPS_CustomFields.md (100%) rename docs/{commands => en-US}/about_JiraPS_UpdatingIssues.md (100%) rename docs/{ => en-US}/commands/Add-JiraGroupMember.md (100%) rename docs/{ => en-US}/commands/Add-JiraIssueAttachment.md (100%) rename docs/{ => en-US}/commands/Add-JiraIssueComment.md (100%) rename docs/{ => en-US}/commands/Add-JiraIssueLink.md (100%) rename docs/{ => en-US}/commands/Add-JiraIssueWatcher.md (100%) rename docs/{ => en-US}/commands/Add-JiraIssueWorklog.md (100%) rename docs/{ => en-US}/commands/Format-Jira.md (100%) rename docs/{ => en-US}/commands/Get-JiraComponent.md (100%) rename docs/{ => en-US}/commands/Get-JiraConfigServer.md (100%) rename docs/{ => en-US}/commands/Get-JiraField.md (100%) rename docs/{ => en-US}/commands/Get-JiraFilter.md (100%) rename docs/{ => en-US}/commands/Get-JiraGroup.md (100%) rename docs/{ => en-US}/commands/Get-JiraGroupMember.md (100%) rename docs/{ => en-US}/commands/Get-JiraIssue.md (100%) rename docs/{ => en-US}/commands/Get-JiraIssueAttachment.md (100%) rename docs/{ => en-US}/commands/Get-JiraIssueComment.md (100%) rename docs/{ => en-US}/commands/Get-JiraIssueCreateMetadata.md (100%) rename docs/{ => en-US}/commands/Get-JiraIssueEditMetadata.md (100%) rename docs/{ => en-US}/commands/Get-JiraIssueLink.md (100%) rename docs/{ => en-US}/commands/Get-JiraIssueLinkType.md (100%) rename docs/{ => en-US}/commands/Get-JiraIssueType.md (100%) rename docs/{ => en-US}/commands/Get-JiraIssueWatcher.md (100%) rename docs/{ => en-US}/commands/Get-JiraPriority.md (100%) rename docs/{ => en-US}/commands/Get-JiraProject.md (100%) rename docs/{ => en-US}/commands/Get-JiraRemoteLink.md (100%) rename docs/{ => en-US}/commands/Get-JiraServerInformation.md (100%) rename docs/{ => en-US}/commands/Get-JiraSession.md (100%) rename docs/{ => en-US}/commands/Get-JiraUser.md (100%) rename docs/{ => en-US}/commands/Get-JiraVersion.md (100%) rename docs/{ => en-US}/commands/Invoke-JiraIssueTransition.md (100%) rename docs/{ => en-US}/commands/New-JiraGroup.md (100%) rename docs/{ => en-US}/commands/New-JiraIssue.md (100%) rename docs/{ => en-US}/commands/New-JiraSession.md (100%) rename docs/{ => en-US}/commands/New-JiraUser.md (100%) rename docs/{ => en-US}/commands/New-JiraVersion.md (100%) rename docs/{ => en-US}/commands/Remove-JiraGroup.md (100%) rename docs/{ => en-US}/commands/Remove-JiraGroupMember.md (100%) rename docs/{ => en-US}/commands/Remove-JiraIssueAttachment.md (100%) rename docs/{ => en-US}/commands/Remove-JiraIssueLink.md (100%) rename docs/{ => en-US}/commands/Remove-JiraIssueWatcher.md (100%) rename docs/{ => en-US}/commands/Remove-JiraRemoteLink.md (100%) rename docs/{ => en-US}/commands/Remove-JiraSession.md (100%) rename docs/{ => en-US}/commands/Remove-JiraUser.md (100%) rename docs/{ => en-US}/commands/Remove-JiraVersion.md (100%) rename docs/{ => en-US}/commands/Set-JiraConfigServer.md (100%) rename docs/{ => en-US}/commands/Set-JiraIssue.md (100%) rename docs/{ => en-US}/commands/Set-JiraIssueLabel.md (100%) rename docs/{ => en-US}/commands/Set-JiraUser.md (100%) rename docs/{ => en-US}/commands/Set-JiraVersion.md (100%) rename docs/{ => en-US}/commands/index.md (100%) diff --git a/docs/commands/about_JiraPS.md b/docs/en-US/about_JiraPS.md similarity index 100% rename from docs/commands/about_JiraPS.md rename to docs/en-US/about_JiraPS.md diff --git a/docs/commands/about_JiraPS_Authentication.md b/docs/en-US/about_JiraPS_Authentication.md similarity index 100% rename from docs/commands/about_JiraPS_Authentication.md rename to docs/en-US/about_JiraPS_Authentication.md diff --git a/docs/commands/about_JiraPS_CreatingIssues.md b/docs/en-US/about_JiraPS_CreatingIssues.md similarity index 100% rename from docs/commands/about_JiraPS_CreatingIssues.md rename to docs/en-US/about_JiraPS_CreatingIssues.md diff --git a/docs/commands/about_JiraPS_CustomFields.md b/docs/en-US/about_JiraPS_CustomFields.md similarity index 100% rename from docs/commands/about_JiraPS_CustomFields.md rename to docs/en-US/about_JiraPS_CustomFields.md diff --git a/docs/commands/about_JiraPS_UpdatingIssues.md b/docs/en-US/about_JiraPS_UpdatingIssues.md similarity index 100% rename from docs/commands/about_JiraPS_UpdatingIssues.md rename to docs/en-US/about_JiraPS_UpdatingIssues.md diff --git a/docs/commands/Add-JiraGroupMember.md b/docs/en-US/commands/Add-JiraGroupMember.md similarity index 100% rename from docs/commands/Add-JiraGroupMember.md rename to docs/en-US/commands/Add-JiraGroupMember.md diff --git a/docs/commands/Add-JiraIssueAttachment.md b/docs/en-US/commands/Add-JiraIssueAttachment.md similarity index 100% rename from docs/commands/Add-JiraIssueAttachment.md rename to docs/en-US/commands/Add-JiraIssueAttachment.md diff --git a/docs/commands/Add-JiraIssueComment.md b/docs/en-US/commands/Add-JiraIssueComment.md similarity index 100% rename from docs/commands/Add-JiraIssueComment.md rename to docs/en-US/commands/Add-JiraIssueComment.md diff --git a/docs/commands/Add-JiraIssueLink.md b/docs/en-US/commands/Add-JiraIssueLink.md similarity index 100% rename from docs/commands/Add-JiraIssueLink.md rename to docs/en-US/commands/Add-JiraIssueLink.md diff --git a/docs/commands/Add-JiraIssueWatcher.md b/docs/en-US/commands/Add-JiraIssueWatcher.md similarity index 100% rename from docs/commands/Add-JiraIssueWatcher.md rename to docs/en-US/commands/Add-JiraIssueWatcher.md diff --git a/docs/commands/Add-JiraIssueWorklog.md b/docs/en-US/commands/Add-JiraIssueWorklog.md similarity index 100% rename from docs/commands/Add-JiraIssueWorklog.md rename to docs/en-US/commands/Add-JiraIssueWorklog.md diff --git a/docs/commands/Format-Jira.md b/docs/en-US/commands/Format-Jira.md similarity index 100% rename from docs/commands/Format-Jira.md rename to docs/en-US/commands/Format-Jira.md diff --git a/docs/commands/Get-JiraComponent.md b/docs/en-US/commands/Get-JiraComponent.md similarity index 100% rename from docs/commands/Get-JiraComponent.md rename to docs/en-US/commands/Get-JiraComponent.md diff --git a/docs/commands/Get-JiraConfigServer.md b/docs/en-US/commands/Get-JiraConfigServer.md similarity index 100% rename from docs/commands/Get-JiraConfigServer.md rename to docs/en-US/commands/Get-JiraConfigServer.md diff --git a/docs/commands/Get-JiraField.md b/docs/en-US/commands/Get-JiraField.md similarity index 100% rename from docs/commands/Get-JiraField.md rename to docs/en-US/commands/Get-JiraField.md diff --git a/docs/commands/Get-JiraFilter.md b/docs/en-US/commands/Get-JiraFilter.md similarity index 100% rename from docs/commands/Get-JiraFilter.md rename to docs/en-US/commands/Get-JiraFilter.md diff --git a/docs/commands/Get-JiraGroup.md b/docs/en-US/commands/Get-JiraGroup.md similarity index 100% rename from docs/commands/Get-JiraGroup.md rename to docs/en-US/commands/Get-JiraGroup.md diff --git a/docs/commands/Get-JiraGroupMember.md b/docs/en-US/commands/Get-JiraGroupMember.md similarity index 100% rename from docs/commands/Get-JiraGroupMember.md rename to docs/en-US/commands/Get-JiraGroupMember.md diff --git a/docs/commands/Get-JiraIssue.md b/docs/en-US/commands/Get-JiraIssue.md similarity index 100% rename from docs/commands/Get-JiraIssue.md rename to docs/en-US/commands/Get-JiraIssue.md diff --git a/docs/commands/Get-JiraIssueAttachment.md b/docs/en-US/commands/Get-JiraIssueAttachment.md similarity index 100% rename from docs/commands/Get-JiraIssueAttachment.md rename to docs/en-US/commands/Get-JiraIssueAttachment.md diff --git a/docs/commands/Get-JiraIssueComment.md b/docs/en-US/commands/Get-JiraIssueComment.md similarity index 100% rename from docs/commands/Get-JiraIssueComment.md rename to docs/en-US/commands/Get-JiraIssueComment.md diff --git a/docs/commands/Get-JiraIssueCreateMetadata.md b/docs/en-US/commands/Get-JiraIssueCreateMetadata.md similarity index 100% rename from docs/commands/Get-JiraIssueCreateMetadata.md rename to docs/en-US/commands/Get-JiraIssueCreateMetadata.md diff --git a/docs/commands/Get-JiraIssueEditMetadata.md b/docs/en-US/commands/Get-JiraIssueEditMetadata.md similarity index 100% rename from docs/commands/Get-JiraIssueEditMetadata.md rename to docs/en-US/commands/Get-JiraIssueEditMetadata.md diff --git a/docs/commands/Get-JiraIssueLink.md b/docs/en-US/commands/Get-JiraIssueLink.md similarity index 100% rename from docs/commands/Get-JiraIssueLink.md rename to docs/en-US/commands/Get-JiraIssueLink.md diff --git a/docs/commands/Get-JiraIssueLinkType.md b/docs/en-US/commands/Get-JiraIssueLinkType.md similarity index 100% rename from docs/commands/Get-JiraIssueLinkType.md rename to docs/en-US/commands/Get-JiraIssueLinkType.md diff --git a/docs/commands/Get-JiraIssueType.md b/docs/en-US/commands/Get-JiraIssueType.md similarity index 100% rename from docs/commands/Get-JiraIssueType.md rename to docs/en-US/commands/Get-JiraIssueType.md diff --git a/docs/commands/Get-JiraIssueWatcher.md b/docs/en-US/commands/Get-JiraIssueWatcher.md similarity index 100% rename from docs/commands/Get-JiraIssueWatcher.md rename to docs/en-US/commands/Get-JiraIssueWatcher.md diff --git a/docs/commands/Get-JiraPriority.md b/docs/en-US/commands/Get-JiraPriority.md similarity index 100% rename from docs/commands/Get-JiraPriority.md rename to docs/en-US/commands/Get-JiraPriority.md diff --git a/docs/commands/Get-JiraProject.md b/docs/en-US/commands/Get-JiraProject.md similarity index 100% rename from docs/commands/Get-JiraProject.md rename to docs/en-US/commands/Get-JiraProject.md diff --git a/docs/commands/Get-JiraRemoteLink.md b/docs/en-US/commands/Get-JiraRemoteLink.md similarity index 100% rename from docs/commands/Get-JiraRemoteLink.md rename to docs/en-US/commands/Get-JiraRemoteLink.md diff --git a/docs/commands/Get-JiraServerInformation.md b/docs/en-US/commands/Get-JiraServerInformation.md similarity index 100% rename from docs/commands/Get-JiraServerInformation.md rename to docs/en-US/commands/Get-JiraServerInformation.md diff --git a/docs/commands/Get-JiraSession.md b/docs/en-US/commands/Get-JiraSession.md similarity index 100% rename from docs/commands/Get-JiraSession.md rename to docs/en-US/commands/Get-JiraSession.md diff --git a/docs/commands/Get-JiraUser.md b/docs/en-US/commands/Get-JiraUser.md similarity index 100% rename from docs/commands/Get-JiraUser.md rename to docs/en-US/commands/Get-JiraUser.md diff --git a/docs/commands/Get-JiraVersion.md b/docs/en-US/commands/Get-JiraVersion.md similarity index 100% rename from docs/commands/Get-JiraVersion.md rename to docs/en-US/commands/Get-JiraVersion.md diff --git a/docs/commands/Invoke-JiraIssueTransition.md b/docs/en-US/commands/Invoke-JiraIssueTransition.md similarity index 100% rename from docs/commands/Invoke-JiraIssueTransition.md rename to docs/en-US/commands/Invoke-JiraIssueTransition.md diff --git a/docs/commands/New-JiraGroup.md b/docs/en-US/commands/New-JiraGroup.md similarity index 100% rename from docs/commands/New-JiraGroup.md rename to docs/en-US/commands/New-JiraGroup.md diff --git a/docs/commands/New-JiraIssue.md b/docs/en-US/commands/New-JiraIssue.md similarity index 100% rename from docs/commands/New-JiraIssue.md rename to docs/en-US/commands/New-JiraIssue.md diff --git a/docs/commands/New-JiraSession.md b/docs/en-US/commands/New-JiraSession.md similarity index 100% rename from docs/commands/New-JiraSession.md rename to docs/en-US/commands/New-JiraSession.md diff --git a/docs/commands/New-JiraUser.md b/docs/en-US/commands/New-JiraUser.md similarity index 100% rename from docs/commands/New-JiraUser.md rename to docs/en-US/commands/New-JiraUser.md diff --git a/docs/commands/New-JiraVersion.md b/docs/en-US/commands/New-JiraVersion.md similarity index 100% rename from docs/commands/New-JiraVersion.md rename to docs/en-US/commands/New-JiraVersion.md diff --git a/docs/commands/Remove-JiraGroup.md b/docs/en-US/commands/Remove-JiraGroup.md similarity index 100% rename from docs/commands/Remove-JiraGroup.md rename to docs/en-US/commands/Remove-JiraGroup.md diff --git a/docs/commands/Remove-JiraGroupMember.md b/docs/en-US/commands/Remove-JiraGroupMember.md similarity index 100% rename from docs/commands/Remove-JiraGroupMember.md rename to docs/en-US/commands/Remove-JiraGroupMember.md diff --git a/docs/commands/Remove-JiraIssueAttachment.md b/docs/en-US/commands/Remove-JiraIssueAttachment.md similarity index 100% rename from docs/commands/Remove-JiraIssueAttachment.md rename to docs/en-US/commands/Remove-JiraIssueAttachment.md diff --git a/docs/commands/Remove-JiraIssueLink.md b/docs/en-US/commands/Remove-JiraIssueLink.md similarity index 100% rename from docs/commands/Remove-JiraIssueLink.md rename to docs/en-US/commands/Remove-JiraIssueLink.md diff --git a/docs/commands/Remove-JiraIssueWatcher.md b/docs/en-US/commands/Remove-JiraIssueWatcher.md similarity index 100% rename from docs/commands/Remove-JiraIssueWatcher.md rename to docs/en-US/commands/Remove-JiraIssueWatcher.md diff --git a/docs/commands/Remove-JiraRemoteLink.md b/docs/en-US/commands/Remove-JiraRemoteLink.md similarity index 100% rename from docs/commands/Remove-JiraRemoteLink.md rename to docs/en-US/commands/Remove-JiraRemoteLink.md diff --git a/docs/commands/Remove-JiraSession.md b/docs/en-US/commands/Remove-JiraSession.md similarity index 100% rename from docs/commands/Remove-JiraSession.md rename to docs/en-US/commands/Remove-JiraSession.md diff --git a/docs/commands/Remove-JiraUser.md b/docs/en-US/commands/Remove-JiraUser.md similarity index 100% rename from docs/commands/Remove-JiraUser.md rename to docs/en-US/commands/Remove-JiraUser.md diff --git a/docs/commands/Remove-JiraVersion.md b/docs/en-US/commands/Remove-JiraVersion.md similarity index 100% rename from docs/commands/Remove-JiraVersion.md rename to docs/en-US/commands/Remove-JiraVersion.md diff --git a/docs/commands/Set-JiraConfigServer.md b/docs/en-US/commands/Set-JiraConfigServer.md similarity index 100% rename from docs/commands/Set-JiraConfigServer.md rename to docs/en-US/commands/Set-JiraConfigServer.md diff --git a/docs/commands/Set-JiraIssue.md b/docs/en-US/commands/Set-JiraIssue.md similarity index 100% rename from docs/commands/Set-JiraIssue.md rename to docs/en-US/commands/Set-JiraIssue.md diff --git a/docs/commands/Set-JiraIssueLabel.md b/docs/en-US/commands/Set-JiraIssueLabel.md similarity index 100% rename from docs/commands/Set-JiraIssueLabel.md rename to docs/en-US/commands/Set-JiraIssueLabel.md diff --git a/docs/commands/Set-JiraUser.md b/docs/en-US/commands/Set-JiraUser.md similarity index 100% rename from docs/commands/Set-JiraUser.md rename to docs/en-US/commands/Set-JiraUser.md diff --git a/docs/commands/Set-JiraVersion.md b/docs/en-US/commands/Set-JiraVersion.md similarity index 100% rename from docs/commands/Set-JiraVersion.md rename to docs/en-US/commands/Set-JiraVersion.md diff --git a/docs/commands/index.md b/docs/en-US/commands/index.md similarity index 100% rename from docs/commands/index.md rename to docs/en-US/commands/index.md From 83f559eba05b6909eb86720f79e562e56c32ab4a Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Wed, 18 Apr 2018 11:40:21 +0200 Subject: [PATCH 4/7] Removed Comment-Based Help from functions --- JiraPS/Public/Add-JiraGroupMember.ps1 | 28 ---------- JiraPS/Public/Add-JiraIssueAttachment.ps1 | 23 --------- JiraPS/Public/Add-JiraIssueComment.ps1 | 30 ----------- JiraPS/Public/Add-JiraIssueLink.ps1 | 21 -------- JiraPS/Public/Add-JiraIssueWatcher.ps1 | 25 --------- JiraPS/Public/Add-JiraIssueWorklog.ps1 | 32 ------------ JiraPS/Public/Format-Jira.ps1 | 24 --------- JiraPS/Public/Get-JiraComponent.ps1 | 30 ----------- JiraPS/Public/Get-JiraConfigServer.ps1 | 19 ------- JiraPS/Public/Get-JiraField.ps1 | 23 --------- JiraPS/Public/Get-JiraFilter.ps1 | 22 -------- JiraPS/Public/Get-JiraGroup.ps1 | 23 --------- JiraPS/Public/Get-JiraGroupMember.ps1 | 34 ------------- JiraPS/Public/Get-JiraIssue.ps1 | 51 ------------------- JiraPS/Public/Get-JiraIssueAttachment.ps1 | 26 ---------- JiraPS/Public/Get-JiraIssueComment.ps1 | 22 -------- JiraPS/Public/Get-JiraIssueCreateMetadata.ps1 | 24 --------- JiraPS/Public/Get-JiraIssueEditMetadata.ps1 | 31 +++-------- JiraPS/Public/Get-JiraIssueLink.ps1 | 25 --------- JiraPS/Public/Get-JiraIssueLinkType.ps1 | 23 --------- JiraPS/Public/Get-JiraIssueType.ps1 | 26 ---------- JiraPS/Public/Get-JiraIssueWatcher.ps1 | 21 -------- JiraPS/Public/Get-JiraPriority.ps1 | 21 -------- JiraPS/Public/Get-JiraProject.ps1 | 27 ---------- JiraPS/Public/Get-JiraRemoteLink.ps1 | 20 -------- JiraPS/Public/Get-JiraServerInformation.ps1 | 17 ------- JiraPS/Public/Get-JiraSession.ps1 | 15 ------ JiraPS/Public/Get-JiraUser.ps1 | 24 --------- JiraPS/Public/Get-JiraVersion.ps1 | 37 -------------- JiraPS/Public/Invoke-JiraIssueTransition.ps1 | 51 ------------------- JiraPS/Public/New-JiraGroup.ps1 | 16 ------ JiraPS/Public/New-JiraIssue.ps1 | 40 --------------- JiraPS/Public/New-JiraSession.ps1 | 24 --------- JiraPS/Public/New-JiraUser.ps1 | 28 ---------- JiraPS/Public/New-JiraVersion.ps1 | 46 ----------------- JiraPS/Public/Remove-JiraGroup.ps1 | 19 ------- JiraPS/Public/Remove-JiraGroupMember.ps1 | 29 ----------- JiraPS/Public/Remove-JiraIssueAttachment.ps1 | 23 --------- JiraPS/Public/Remove-JiraIssueLink.ps1 | 20 -------- JiraPS/Public/Remove-JiraIssueWatcher.ps1 | 25 --------- JiraPS/Public/Remove-JiraRemoteLink.ps1 | 21 -------- JiraPS/Public/Remove-JiraSession.ps1 | 30 ----------- JiraPS/Public/Remove-JiraUser.ps1 | 22 -------- JiraPS/Public/Remove-JiraVersion.ps1 | 28 ---------- JiraPS/Public/Set-JiraConfigServer.ps1 | 20 -------- JiraPS/Public/Set-JiraIssue.ps1 | 39 -------------- JiraPS/Public/Set-JiraIssueLabel.ps1 | 38 -------------- JiraPS/Public/Set-JiraUser.ps1 | 32 ------------ 48 files changed, 8 insertions(+), 1287 deletions(-) diff --git a/JiraPS/Public/Add-JiraGroupMember.ps1 b/JiraPS/Public/Add-JiraGroupMember.ps1 index f8e40360..19d19b2c 100644 --- a/JiraPS/Public/Add-JiraGroupMember.ps1 +++ b/JiraPS/Public/Add-JiraGroupMember.ps1 @@ -1,36 +1,11 @@ function Add-JiraGroupMember { - <# - .Synopsis - Adds a user to a JIRA group - .DESCRIPTION - This function adds a JIRA user to a JIRA group. - .EXAMPLE - Add-JiraGroupMember -Group testUsers -User jsmith - This example adds the user jsmith to the group testUsers - .EXAMPLE - Get-JiraGroup 'Project Admins' | Add-JiraGroupMember -User jsmith - This example illustrates the use of the pipeline to add jsmith to the - "Project Admins" group in JIRA. - .INPUTS - [JiraPS.Group[]] Group(s) to which users should be added - .OUTPUTS - If the -PassThru parameter is provided, this function will provide a - reference to the JIRA group modified. Otherwise, this function does not - provide output. - .NOTES - This REST method is still marked Experimental in JIRA's REST API. That - means that there is a high probability this will break in future - versions of JIRA. The function will need to be re-written at that time. - #> [CmdletBinding( SupportsShouldProcess )] param( - # Group (or list of groups) to which the user(s) will be added. [Parameter( Mandatory, ValueFromPipeline )] [Alias('GroupName')] [Object[]] $Group, - # Username or user object obtained from Get-JiraUser. [Parameter( Mandatory )] [Object[]] $UserName, @@ -39,12 +14,9 @@ function Add-JiraGroupMember { Once we have custom classes, this can also accept ValueFromPipeline #> - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Whether output should be provided after invoking this function. [Switch] $PassThru ) diff --git a/JiraPS/Public/Add-JiraIssueAttachment.ps1 b/JiraPS/Public/Add-JiraIssueAttachment.ps1 index eea99509..ff6ada3b 100644 --- a/JiraPS/Public/Add-JiraIssueAttachment.ps1 +++ b/JiraPS/Public/Add-JiraIssueAttachment.ps1 @@ -1,25 +1,6 @@ function Add-JiraIssueAttachment { - <# - .SYNOPSIS - Adds a file attachment to an existing Jira Issue - .DESCRIPTION - This function adds an Attachment to an existing issue in JIRA. - .EXAMPLE - Add-JiraIssueAttachment -FilePath "Test comment" -Issue "TEST-001" - This example adds a simple comment to the issue TEST-001. - .EXAMPLE - Get-JiraIssue "TEST-002" | Add-JiraIssueAttachment -FilePath "Test comment from PowerShell" - This example illustrates pipeline use from Get-JiraIssue to Add-JiraIssueAttachment. - .INPUTS - This function can accept JiraPS.Issue objects via pipeline. - .OUTPUTS - This function outputs the results of the attachment add. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( SupportsShouldProcess )] param( - # Issue to which to attach the file [Parameter( Mandatory )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -51,7 +32,6 @@ function Add-JiraIssueAttachment { Once we have custom classes, this can also accept ValueFromPipeline #> - # Path of the file to upload and attach [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateScript( { @@ -74,12 +54,9 @@ function Add-JiraIssueAttachment { [String[]] $FilePath, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Whether output should be provided after invoking this function [Switch] $PassThru ) diff --git a/JiraPS/Public/Add-JiraIssueComment.ps1 b/JiraPS/Public/Add-JiraIssueComment.ps1 index 05ed56d7..f12b7b33 100644 --- a/JiraPS/Public/Add-JiraIssueComment.ps1 +++ b/JiraPS/Public/Add-JiraIssueComment.ps1 @@ -1,38 +1,11 @@ function Add-JiraIssueComment { - <# - .SYNOPSIS - Adds a comment to an existing JIRA issue - .DESCRIPTION - This function adds a comment to an existing issue in JIRA. You can optionally set the visibility of the comment (All Users, Developers, or Administrators). - .EXAMPLE - Add-JiraIssueComment -Comment "Test comment" -Issue "TEST-001" - This example adds a simple comment to the issue TEST-001. - .EXAMPLE - Get-JiraIssue "TEST-002" | Add-JiraIssueComment "Test comment from PowerShell" - This example illustrates pipeline use from Get-JiraIssue to Add-JiraIssueComment. - .EXAMPLE - Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | % { Add-JiraIssueComment "This issue has been cancelled per Vice President's orders." } - This example illustrates commenting on all projects which match a given JQL query. It would be best to validate the query first to make sure the query returns the expected issues! - .EXAMPLE - $comment = Get-Process | Format-Jira - Add-JiraIssueComment $c -Issue TEST-003 - This example illustrates adding a comment based on other logic to a JIRA issue. Note the use of Format-Jira to convert the output of Get-Process into a format that is easily read by users. - .INPUTS - This function can accept JiraPS.Issue objects via pipeline. - .OUTPUTS - This function outputs the JiraPS.Comment object created. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( SupportsShouldProcess )] param( - # Comment that should be added to JIRA. [Parameter( Mandatory )] [ValidateNotNullOrEmpty()] [String] $Comment, - # Issue that should be commented upon. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -60,13 +33,10 @@ function Add-JiraIssueComment { [Object] $Issue, - # Visibility of the comment - should it be publicly visible, viewable to only developers, or only administrators? [ValidateSet('All Users', 'Developers', 'Administrators')] [String] $VisibleRole = 'All Users', - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Add-JiraIssueLink.ps1 b/JiraPS/Public/Add-JiraIssueLink.ps1 index 6cfa41ef..ed8fca9c 100644 --- a/JiraPS/Public/Add-JiraIssueLink.ps1 +++ b/JiraPS/Public/Add-JiraIssueLink.ps1 @@ -1,23 +1,6 @@ function Add-JiraIssueLink { - <# - .SYNOPSIS - Adds a link between two Issues on Jira - .DESCRIPTION - Creates a new link of the specified type between two Issue. - .EXAMPLE - $_issueLink = [PSCustomObject]@{ - outwardIssue = [PSCustomObject]@{key = "TEST-10"} - type = [PSCustomObject]@{name = "Composition"} - } - Add-JiraIssueLink -Issue TEST-01 -IssueLink $_issueLink - Creates a link "is part of" between TEST-01 and TEST-10 - .INPUTS - [JiraPS.Issue[]] The JIRA issue that should be linked - [JiraPS.IssueLink[]] The JIRA issue link that should be used - #> [CmdletBinding( SupportsShouldProcess )] param( - # Issue key or JiraPS.Issue object returned from Get-JiraIssue [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -45,7 +28,6 @@ function Add-JiraIssueLink { [Object[]] $Issue, - # Issue Link to be created. [Parameter( Mandatory )] [ValidateScript( { @@ -75,12 +57,9 @@ function Add-JiraIssueLink { [Object[]] $IssueLink, - # Write a comment to the issue [String] $Comment, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Add-JiraIssueWatcher.ps1 b/JiraPS/Public/Add-JiraIssueWatcher.ps1 index 9964a296..f5bd9378 100644 --- a/JiraPS/Public/Add-JiraIssueWatcher.ps1 +++ b/JiraPS/Public/Add-JiraIssueWatcher.ps1 @@ -1,28 +1,6 @@ function Add-JiraIssueWatcher { - <# - .SYNOPSIS - Adds a watcher to an existing JIRA issue - .DESCRIPTION - This function adds a watcher to an existing issue in JIRA. - .EXAMPLE - Add-JiraIssueWatcher -Watcher "fred" -Issue "TEST-001" - This example adds a watcher to the issue TEST-001. - .EXAMPLE - Get-JiraIssue "TEST-002" | Add-JiraIssueWatcher "fred" - This example illustrates pipeline use from Get-JiraIssue to Add-JiraIssueWatcher. - .EXAMPLE - Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | % { Add-JiraIssueWatcher "fred" } - This example illustrates adding watcher on all projects which match a given JQL query. It would be best to validate the query first to make sure the query returns the expected issues! - .INPUTS - This function can accept JiraPS.Issue objects via pipeline. - .OUTPUTS - This function does not provide output. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( SupportsShouldProcess )] param( - # Watcher that should be added to JIRA [Parameter( Mandatory )] [String[]] $Watcher, @@ -31,7 +9,6 @@ Once we have custom classes, this can also accept ValueFromPipeline #> - # Issue that should be watched [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -59,8 +36,6 @@ [Object] $Issue, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Add-JiraIssueWorklog.ps1 b/JiraPS/Public/Add-JiraIssueWorklog.ps1 index 72a63905..b9e6100b 100644 --- a/JiraPS/Public/Add-JiraIssueWorklog.ps1 +++ b/JiraPS/Public/Add-JiraIssueWorklog.ps1 @@ -1,38 +1,11 @@ function Add-JiraIssueWorklog { - <# - .SYNOPSIS - Adds a worklog item to an existing JIRA issue - .DESCRIPTION - This function adds a worklog item to an existing issue in JIRA. You can optionally set the visibility of the item (All Users, Developers, or Administrators). - .EXAMPLE - Add-JiraIssueWorklog -Comment "Test comment" -Issue "TEST-001" -TimeSpent 60 -DateStarted (Get-Date) - This example adds a simple worklog item to the issue TEST-001. - .EXAMPLE - Get-JiraIssue "TEST-002" | Add-JiraIssueWorklog "Test worklog item from PowerShell" -TimeSpent 60 -DateStarted (Get-Date) - This example illustrates pipeline use from Get-JiraIssue to Add-JiraIssueWorklog. - .EXAMPLE - Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | % { Add-JiraIssueWorklog "This issue has been cancelled per Vice President's orders." -TimeSpent 60 -DateStarted (Get-Date)} - This example illustrates logging work on all projects which match a given JQL query. It would be best to validate the query first to make sure the query returns the expected issues! - .EXAMPLE - $comment = Get-Process | Format-Jira - Add-JiraIssueWorklog $c -Issue TEST-003 -TimeSpent 60 -DateStarted (Get-Date) - This example illustrates adding a comment based on other logic to a JIRA issue. Note the use of Format-Jira to convert the output of Get-Process into a format that is easily read by users. - .INPUTS - This function can accept JiraPS.Issue objects via pipeline. - .OUTPUTS - This function outputs the JiraPS.Worklogitem object created. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( SupportsShouldProcess )] param( - # Worklog item that should be added to JIRA [Parameter( Mandatory )] [ValidateNotNullOrEmpty()] [String] $Comment, - # Issue to receive the new worklog item [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -60,23 +33,18 @@ function Add-JiraIssueWorklog { [Object] $Issue, - # Time spent to be logged [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [TimeSpan] $TimeSpent, - # Date/time started to be logged [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [DateTime] $DateStarted, - # Visibility of the comment - should it be publicly visible, viewable to only developers, or only administrators? [ValidateSet('All Users', 'Developers', 'Administrators')] [String] $VisibleRole = 'All Users', - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Format-Jira.ps1 b/JiraPS/Public/Format-Jira.ps1 index a8731af4..58e2d257 100644 --- a/JiraPS/Public/Format-Jira.ps1 +++ b/JiraPS/Public/Format-Jira.ps1 @@ -1,36 +1,12 @@ function Format-Jira { - <# - .SYNOPSIS - Converts an object into a table formatted according to JIRA's markdown syntax - .DESCRIPTION - This function converts a PowerShell object into a table using JIRA's markdown syntax. This can then be added to a JIRA issue description or comment. - - Like the native Format-* cmdlets, this is a destructive operation, so as always, remember to "filter left, format right!" - .EXAMPLE - Get-Process | Format-Jira | Add-JiraIssueComment -Issue TEST-001 - This example illustrates converting the output from Get-Process into a JIRA table, which is then added as a comment to issue TEST-001. - .EXAMPLE - Get-Process chrome | Format-Jira Name,Id,VM - This example obtains all Google Chrome processes, then creates a JIRA table with only the Name,ID, and VM properties of each object. - .INPUTS - [System.Object[]] - accepts any Object via pipeline - .OUTPUTS - [System.String] - .NOTES - This is a destructive operation, since it permanently reduces InputObjects to Strings. Remember to "filter left, format right." - #> [CmdletBinding()] [OutputType([System.String])] param( - # Object to format. [Parameter( Mandatory, ValueFromPipeline, ValueFromRemainingArguments )] [ValidateNotNull()] [PSObject[]] $InputObject, - # List of properties to display. If omitted, only the default properties will be shown. - # - # To display all properties, use -Property *. [Object[]] $Property ) diff --git a/JiraPS/Public/Get-JiraComponent.ps1 b/JiraPS/Public/Get-JiraComponent.ps1 index 4d60c3db..04c218d7 100644 --- a/JiraPS/Public/Get-JiraComponent.ps1 +++ b/JiraPS/Public/Get-JiraComponent.ps1 @@ -1,33 +1,6 @@ function Get-JiraComponent { - <# - .SYNOPSIS - Returns a Component from Jira - .DESCRIPTION - This function returns information regarding a specified component from Jira. - If -InputObject is given via parameter or pipe all components for - the given project are returned. - It is not possible to get all components with this function. - .EXAMPLE - Get-JiraComponent -Id 10000 -Credential $cred - Returns information about the component with ID 10000 - .EXAMPLE - Get-JiraComponent 20000 -Credential $cred - Returns information about the component with ID 20000 - .EXAMPLE - Get-JiraProject Project1 | Get-JiraComponent -Credential $cred - Returns information about all components within project 'Project1' - .EXAMPLE - Get-JiraComponent ABC,DEF - Return information about all components within projects 'ABC' and 'DEF' - .INPUTS - [String[]] Component ID - [PSCredential] Credentials to use to connect to Jira - .OUTPUTS - [JiraPS.Component] - #> [CmdletBinding(DefaultParameterSetName = 'ByID')] param( - # The Project ID or project key of a project to search. [Parameter( Position = 0, Mandatory, ValueFromPipeline, ParameterSetName = 'ByProject' )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -58,14 +31,11 @@ function Get-JiraComponent { Once we have custom classes, these two parameters can be one #> - # The Component ID. [Parameter( Position = 0, Mandatory, ParameterSetName = 'ByID' )] [Alias("Id")] [Int[]] $ComponentId, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraConfigServer.ps1 b/JiraPS/Public/Get-JiraConfigServer.ps1 index 5c83ecdd..205a50d4 100644 --- a/JiraPS/Public/Get-JiraConfigServer.ps1 +++ b/JiraPS/Public/Get-JiraConfigServer.ps1 @@ -1,26 +1,7 @@ function Get-JiraConfigServer { - <# - .SYNOPSIS - Obtains the configured URL for the JIRA server - .DESCRIPTION - This function returns the configured URL for the JIRA server that JiraPS should manipulate. By default, this is stored in a config.xml file at the module's root path. - .EXAMPLE - Get-JiraConfigServer - Returns the server URL of the JIRA server configured in the JiraPS config file. - .EXAMPLE - Get-JiraConfigServer -ConfigFile C:\jiraconfig.xml - Returns the server URL of the JIRA server configured at C:\jiraconfig.xml. - .INPUTS - This function does not accept pipeline input. - .OUTPUTS - [System.String] - .NOTES - Support for multiple configuration files is limited at this point in time, but enhancements are planned for a future update. - #> [CmdletBinding()] [OutputType([System.String])] param( - # Path to the configuration file, if not the default. [String] $ConfigFile ) diff --git a/JiraPS/Public/Get-JiraField.ps1 b/JiraPS/Public/Get-JiraField.ps1 index e2b26f57..21697071 100644 --- a/JiraPS/Public/Get-JiraField.ps1 +++ b/JiraPS/Public/Get-JiraField.ps1 @@ -1,33 +1,10 @@ function Get-JiraField { - <# - .SYNOPSIS - This function returns information about JIRA fields - .DESCRIPTION - This function provides information about JIRA fields, or about one field in particular. This is a good way to identify a field's ID by its name, or vice versa. - - Typically, this information is only needed when identifying what fields are necessary to create or edit issues. See Get-JiraIssueCreateMetadata for more details. - .EXAMPLE - Get-JiraField - This example returns information about all JIRA fields visible to the current user (or using anonymous access if a JiraPS session has not been defined). - .EXAMPLE - Get-JiraField IssueKey - This example returns information about the IssueKey field. - .INPUTS - This function does not accept pipeline input. - .OUTPUTS - This function outputs the JiraPS.Field object(s) that represent the JIRA field(s). - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( DefaultParameterSetName = '_All' )] param( - # The Field name or ID to search. [Parameter( Position = 0, Mandatory, ValueFromPipeline, ParameterSetName = '_Search' )] [String[]] $Field, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraFilter.ps1 b/JiraPS/Public/Get-JiraFilter.ps1 index ff9f6896..4ca4d6b8 100644 --- a/JiraPS/Public/Get-JiraFilter.ps1 +++ b/JiraPS/Public/Get-JiraFilter.ps1 @@ -1,25 +1,6 @@ function Get-JiraFilter { - <# - .SYNOPSIS - Returns information about a filter in JIRA - .DESCRIPTION - This function returns information about a filter in JIRA, including the JQL syntax of the filter, its owner, and sharing status. - - This function is only capable of returning filters by their Filter ID. This is a limitation of JIRA's REST API. The easiest way to obtain the ID of a filter is to load the filter in the "regular" Web view of JIRA, then copy the ID from the URL of the page. - .EXAMPLE - Get-JiraFilter -Id 12345 - Gets a reference to filter ID 12345 from JIRA - .EXAMPLE - $filterObject | Get-JiraFilter - Gets the information of a filter by providing a filter object - .INPUTS - [Object[]] The filter to look up in JIRA. This can be a String (filter ID) or a JiraPS.Filter object. - .OUTPUTS - [JiraPS.Filter[]] Filter objects - #> [CmdletBinding(DefaultParameterSetName = 'ByFilterID')] param( - # ID of the filter to search for. [Parameter( Position = 0, Mandatory, ParameterSetName = 'ByFilterID' )] [String[]] $Id, @@ -30,7 +11,6 @@ and we will no longer need the InputObject #> - # Object of the filter to search for. [Parameter( Mandatory, ValueFromPipeline, ParameterSetName = 'ByInputObject' )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -57,8 +37,6 @@ [Object[]] $InputObject, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraGroup.ps1 b/JiraPS/Public/Get-JiraGroup.ps1 index 6f7b1fe9..43f74bac 100644 --- a/JiraPS/Public/Get-JiraGroup.ps1 +++ b/JiraPS/Public/Get-JiraGroup.ps1 @@ -1,35 +1,12 @@ function Get-JiraGroup { - <# - .SYNOPSIS - Returns a group from Jira - .DESCRIPTION - This function returns information regarding a specified group from JIRA. - - By default, this function does not display members of the group. This is JIRA's default - behavior as well. To display group members, use Get-JiraGroupMember. - .EXAMPLE - Get-JiraGroup -GroupName testGroup -Credential $cred - Returns information about the group "testGroup" - .EXAMPLE - Get-ADUser -filter "Name -like 'John*Smith'" | Select-Object -ExpandProperty samAccountName | Get-JiraUser -Credential $cred - This example searches Active Directory for the username of John W. Smith, John H. Smith, - and any other John Smiths, then obtains their JIRA user accounts. - .INPUTS - [Object[]] The group to look up in JIRA. This can be a String or a JiraPS.Group object. - .OUTPUTS - [JiraPS.Group] - #> [CmdletBinding()] param( - # Name of the group to search for. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [Alias('Name')] [String[]] $GroupName, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraGroupMember.ps1 b/JiraPS/Public/Get-JiraGroupMember.ps1 index bd57f44b..1c0ac0df 100644 --- a/JiraPS/Public/Get-JiraGroupMember.ps1 +++ b/JiraPS/Public/Get-JiraGroupMember.ps1 @@ -1,34 +1,6 @@ function Get-JiraGroupMember { - <# - .SYNOPSIS - Returns members of a given group in JIRA - .DESCRIPTION - This function returns members of a provided group in JIRA. - .EXAMPLE - Get-JiraGroupmember testGroup - This example returns all members of the JIRA group testGroup. - .EXAMPLE - Get-JiraGroup 'Developers' | Get-JiraGroupMember - This example illustrates the use of the pipeline to return members of - the Developers group in JIRA. - .INPUTS - [JiraPS.Group] The group to query for members - .OUTPUTS - [JiraPS.User[]] Members of the provided group - .NOTES - By default, this will return all active users who are members of the - given group. For large groups, this can take quite some time. - - To limit the number of group members returned, use - the MaxResults parameter. You can also combine this with the - StartIndex parameter to "page" through results. - - This function does not return inactive users. This appears to be a - limitation of JIRA's REST API. - #> [CmdletBinding()] param( - # Group object of which to display the members. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -55,20 +27,14 @@ function Get-JiraGroupMember { [Object[]] $Group, - # Index of the first user to return. This can be used to "page" through - # users in a large group or a slow connection. [ValidateRange(0, [Int]::MaxValue)] [Int] $StartIndex = 0, - # Maximum number of results to return. By default, all users will be - # returned. [ValidateRange(0, [Int]::MaxValue)] [Int] $MaxResults = 0, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraIssue.ps1 b/JiraPS/Public/Get-JiraIssue.ps1 index 41b24cc1..552a3af7 100644 --- a/JiraPS/Public/Get-JiraIssue.ps1 +++ b/JiraPS/Public/Get-JiraIssue.ps1 @@ -1,50 +1,11 @@ function Get-JiraIssue { - <# - .SYNOPSIS - Returns information about an issue in JIRA. - .DESCRIPTION - This function obtains references to issues in JIRA. - - This function can be used to directly query JIRA for a specific issue key or internal issue ID. It can also be used to query JIRA for issues matching a specific criteria using JQL (Jira Query Language). - - For more details on JQL syntax, see this articla from Atlassian: https://confluence.atlassian.com/display/JIRA/Advanced+Searching - - Output from this function can be piped to various other functions in this module, including Set-JiraIssue, Add-JiraIssueComment, and Invoke-JiraIssueTransition. - .EXAMPLE - Get-JiraIssue -Key TEST-001 - This example returns a reference to JIRA issue TEST-001. - .EXAMPLE - Get-JiraIssue "TEST-002" | Add-JiraIssueComment "Test comment from PowerShell" - This example illustrates pipeline use from Get-JiraIssue to Add-JiraIssueComment. - .EXAMPLE - Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' - This example illustrates using the Query parameter and JQL syntax to query Jira for matching issues. - .EXAMPLE - Get-JiraIssue -InputObject $oldIssue - This example illustrates how to get an update of an issue from an old result of Get-JiraIssue stored in $oldIssue. - .EXAMPLE - Get-JiraFilter -Id 12345 | Get-JiraIssue - This example retrieves all issues that match the criteria in the saved fiilter with id 12345. - .INPUTS - This function can accept JiraPS.Issue objects, Strings, or Objects via the pipeline. - - * If a JiraPS.Issue object is passed, this function returns a new reference to the same issue. - * If a String is passed, this function searches for an issue with that issue key or internal ID. - * If an Object is passed, this function invokes its ToString() method and treats it as a String. - .OUTPUTS - This function outputs the JiraPS.Issue object retrieved. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding(DefaultParameterSetName = 'ByIssueKey')] param( - # Key of the issue to search for. [Parameter( Position = 0, Mandatory, ParameterSetName = 'ByIssueKey' )] [ValidateNotNullOrEmpty()] [String[]] $Key, - # Object of an issue to search for. [Parameter( Position = 0, Mandatory, ParameterSetName = 'ByInputObject' )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -73,13 +34,11 @@ function Get-JiraIssue { Once we have custom classes, this check can be done with Type declaration #> - # JQL query for which to search for. [Parameter( Mandatory, ParameterSetName = 'ByJQL' )] [Alias('JQL')] [String] $Query, - # Object of an existing JIRA filter from which the results will be returned. [Parameter( Mandatory, ParameterSetName = 'ByFilter' )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -106,31 +65,21 @@ function Get-JiraIssue { [Object] $Filter, - # Index of the first issue to return. This can be used to "page" through - # issues in a large collection or a slow connection. [Parameter( ParameterSetName = 'ByJQL' )] [Parameter( ParameterSetName = 'ByFilter' )] [Int] $StartIndex = 0, - # Maximum number of results to return. By default, all issues will be - # returned. [Parameter( ParameterSetName = 'ByJQL' )] [Parameter( ParameterSetName = 'ByFilter' )] [Int] $MaxResults = 0, - # How many issues should be returned per call to JIRA. This parameter - # only has effect if $MaxResults is not provided or set to 0. Normally, - # you should not need to adjust this parameter, but if the REST calls - # take a long time, try playing with different values here. [Parameter( ParameterSetName = 'ByJQL' )] [Parameter( ParameterSetName = 'ByFilter' )] [Int] $PageSize = 50, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraIssueAttachment.ps1 b/JiraPS/Public/Get-JiraIssueAttachment.ps1 index ba5bb9c9..e1241e41 100644 --- a/JiraPS/Public/Get-JiraIssueAttachment.ps1 +++ b/JiraPS/Public/Get-JiraIssueAttachment.ps1 @@ -1,28 +1,6 @@ function Get-JiraIssueAttachment { - <# - .SYNOPSIS - Returns attachments of an issue in JIRA. - .DESCRIPTION - This function obtains attachments from existing issues in JIRA. - .EXAMPLE - Get-JiraIssueAttachment -Issue TEST-001 - This example returns all attachments from issue TEST-001. - .EXAMPLE - Get-JiraIssue TEST-002 | Get-JiraIssueAttachment - This example illustrates use of the pipeline to return all attachments from issue TEST-002. - .EXAMPLE - Get-JiraIssue TEST-002 | Get-JiraIssueAttachment -FileName "*.png" - Returns all attachments of issue TEST-002 where the filename ends in .png - .INPUTS - This function can accept JiraPS.Issue objects, Strings, or Objects via the pipeline. It uses Get-JiraIssue to identify the issue parameter; see its Inputs section for details on how this function handles inputs. - .OUTPUTS - JiraPS.Attachment - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding()] param( - # JIRA issue to check for attachments. Can be a JiraPS.Issue object, issue key, or internal issue ID. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -50,13 +28,9 @@ function Get-JiraIssueAttachment { [Object] $Issue, - # Name of the file(s) to filter. - # This parameter supports wildchards. [String] $FileName, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraIssueComment.ps1 b/JiraPS/Public/Get-JiraIssueComment.ps1 index ea661203..17c8bb53 100644 --- a/JiraPS/Public/Get-JiraIssueComment.ps1 +++ b/JiraPS/Public/Get-JiraIssueComment.ps1 @@ -1,26 +1,6 @@ function Get-JiraIssueComment { - <# - .SYNOPSIS - Returns comments on an issue in JIRA. - .DESCRIPTION - This function obtains comments from existing issues in JIRA. - .EXAMPLE - Get-JiraIssueComment -Key TEST-001 - This example returns all comments posted to issue TEST-001. - .EXAMPLE - Get-JiraIssue TEST-002 | Get-JiraIssueComment - This example illustrates use of the pipeline to return all comments on issue TEST-002. - .INPUTS - This function can accept JiraPS.Issue objects, Strings, or Objects via the pipeline. It uses Get-JiraIssue to identify the issue parameter; see its Inputs section for details on how this function handles inputs. - .OUTPUTS - This function outputs all JiraPS.Comment issues associated with the provided issue. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding()] param( - # JIRA issue to check for comments. - # Can be a JiraPS.Issue object, issue key, or internal issue ID. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -48,8 +28,6 @@ function Get-JiraIssueComment { [Object] $Issue, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraIssueCreateMetadata.ps1 b/JiraPS/Public/Get-JiraIssueCreateMetadata.ps1 index 4f210bdc..3caf79f1 100644 --- a/JiraPS/Public/Get-JiraIssueCreateMetadata.ps1 +++ b/JiraPS/Public/Get-JiraIssueCreateMetadata.ps1 @@ -1,38 +1,14 @@ function Get-JiraIssueCreateMetadata { - <# - .SYNOPSIS - Returns metadata required to create an issue in JIRA - .DESCRIPTION - This function returns metadata required to create an issue in JIRA - the fields that can be defined in the process of creating an issue. This can be used to identify custom fields in order to pass them to New-JiraIssue. - - This function is particularly useful when your JIRA instance includes custom fields that are marked as mandatory. The required fields can be identified from this See the examples for more details on this approach. - .EXAMPLE - Get-JiraIssueCreateMetadata -Project 'TEST' -IssueType 'Bug' - This example returns the fields available when creating an issue of type Bug under project TEST. - .EXAMPLE - Get-JiraIssueCreateMetadata -Project 'JIRA' -IssueType 'Bug' | ? {$_.Required -eq $true} - This example returns fields available when creating an issue of type Bug under the project Jira. It then uses Where-Object (aliased by the question mark) to filter only the fields that are required. - .INPUTS - This function does not accept pipeline input. - .OUTPUTS - This function outputs the JiraPS.Field objects that represent JIRA's create metadata. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding()] param( - # Project ID or key of the reference issue. [Parameter( Mandatory )] [String] $Project, - # Issue type ID or name. [Parameter( Mandatory )] [String] $IssueType, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraIssueEditMetadata.ps1 b/JiraPS/Public/Get-JiraIssueEditMetadata.ps1 index 3256cd2d..fa567744 100644 --- a/JiraPS/Public/Get-JiraIssueEditMetadata.ps1 +++ b/JiraPS/Public/Get-JiraIssueEditMetadata.ps1 @@ -1,33 +1,14 @@ function Get-JiraIssueEditMetadata { - <# - .SYNOPSIS - Returns metadata required to create an issue in JIRA - .DESCRIPTION - This function returns metadata required to create an issue in JIRA - the fields that can be defined in the process of creating an issue. This can be used to identify custom fields in order to pass them to New-JiraIssue. - - This function is particularly useful when your JIRA instance includes custom fields that are marked as mandatory. The required fields can be identified from this See the examples for more details on this approach. - .EXAMPLE - Get-JiraIssueEditMetadata -Project 'TEST' -IssueType 'Bug' - This example returns the fields available when creating an issue of type Bug under project TEST. - .EXAMPLE - Get-JiraIssueEditMetadata -Project 'JIRA' -IssueType 'Bug' | ? {$_.Required -eq $true} - This example returns fields available when creating an issue of type Bug under the project Jira. It then uses Where-Object (aliased by the question mark) to filter only the fields that are required. - .INPUTS - This function does not accept pipeline input. - .OUTPUTS - This function outputs the JiraPS.Field objects that represent JIRA's create metadata. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding()] param( - # Issue id or key of the reference issue. [Parameter( Mandatory )] [String] $Issue, + <# + #ToDo:CustomClass + Once we have custom classes, this should be a JiraPS.Issue + #> - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) @@ -46,6 +27,10 @@ function Get-JiraIssueEditMetadata { $parameter = @{ URI = $resourceURi -f $Issue + <# + #ToDo:CustomClass + When the Input is typecasted to a JiraPS.Issue, the `self` of the issue can be used + #> Method = "GET" Credential = $Credential } diff --git a/JiraPS/Public/Get-JiraIssueLink.ps1 b/JiraPS/Public/Get-JiraIssueLink.ps1 index 7dc79c93..93c84f2f 100644 --- a/JiraPS/Public/Get-JiraIssueLink.ps1 +++ b/JiraPS/Public/Get-JiraIssueLink.ps1 @@ -1,35 +1,10 @@ function Get-JiraIssueLink { - <# - .SYNOPSIS - Returns a specific issueLink from Jira - .DESCRIPTION - This function returns information regarding a specified issueLink from Jira. - .EXAMPLE - Get-JiraIssueLink 10000 - Returns information about the IssueLink with ID 10000 - .EXAMPLE - Get-JiraIssueLink -IssueLink 10000 - Returns information about the IssueLink with ID 10000 - .EXAMPLE - (Get-JiraIssue TEST-01).issuelinks | Get-JiraIssueLink - Returns the information about all IssueLinks in issue TEST-01 - .INPUTS - [Int[]] issueLink ID - [PSCredential] Credentials to use to connect to Jira - .OUTPUTS - [JiraPS.IssueLink] - #> [CmdletBinding()] param( - # The IssueLink ID to search - # - # Accepts input from pipeline when the object is of type JiraPS.IssueLink [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [Int[]] $Id, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraIssueLinkType.ps1 b/JiraPS/Public/Get-JiraIssueLinkType.ps1 index a3d73889..6beecaca 100644 --- a/JiraPS/Public/Get-JiraIssueLinkType.ps1 +++ b/JiraPS/Public/Get-JiraIssueLinkType.ps1 @@ -1,27 +1,6 @@ function Get-JiraIssueLinkType { - <# - .SYNOPSIS - Gets available issue link types - .DESCRIPTION - This function gets available issue link types from a JIRA server. It can also return specific information about a single issue link type. - - This is a useful function for discovering data about issue link types in order to create and modify issue links on issues. - .EXAMPLE - C:\PS> Get-JiraIssueLinkType - This example returns all available links fron the JIRA server - .EXAMPLE - C:\PS> Get-JiraIssueLinkType -LinkType 1 - This example returns information about the link type with ID 1. - .INPUTS - This function does not accept pipeline input. - .OUTPUTS - This function outputs the JiraPS.IssueLinkType object(s) that represent the JIRA issue link type(s). - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( DefaultParameterSetName = '_All' )] param( - # The Issue Type name or ID to search [Parameter( Position = 0, Mandatory, ParameterSetName = '_Search' )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -48,8 +27,6 @@ function Get-JiraIssueLinkType { [Object] $LinkType, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraIssueType.ps1 b/JiraPS/Public/Get-JiraIssueType.ps1 index cf5622b9..0c9e67bf 100644 --- a/JiraPS/Public/Get-JiraIssueType.ps1 +++ b/JiraPS/Public/Get-JiraIssueType.ps1 @@ -1,36 +1,10 @@ function Get-JiraIssueType { - <# - .SYNOPSIS - Returns information about the available issue type in JIRA. - .DESCRIPTION - This function retrieves all the available IssueType on the JIRA server an returns them as JiraPS.IssueType. - - This function can restrict the output to a subset of the available IssueTypes if told so. - .EXAMPLE - Get-JiraIssueType - This example returns all the IssueTypes on the JIRA server. - .EXAMPLE - Get-JiraIssueType -IssueType "Bug" - This example returns only the IssueType "Bug". - .EXAMPLE - Get-JiraIssueType -IssueType "Bug","Task","4" - This example return the information about the IssueType named "Bug" and "Task" and with id "4". - .INPUTS - This function accepts Strings via the pipeline. - .OUTPUTS - This function outputs the JiraPS.IssueType object retrieved. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( DefaultParameterSetName = '_All' )] param( - # The Issue Type name or ID to search. [Parameter( Position = 0, Mandatory, ValueFromPipeline, ParameterSetName = '_Search' )] [String[]] $IssueType, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraIssueWatcher.ps1 b/JiraPS/Public/Get-JiraIssueWatcher.ps1 index cf561558..ab3b74f2 100644 --- a/JiraPS/Public/Get-JiraIssueWatcher.ps1 +++ b/JiraPS/Public/Get-JiraIssueWatcher.ps1 @@ -1,25 +1,6 @@ function Get-JiraIssueWatcher { - <# - .SYNOPSIS - Returns watchers on an issue in JIRA. - .DESCRIPTION - This function obtains watchers from existing issues in JIRA. - .EXAMPLE - Get-JiraIssueWatcher -Key TEST-001 - This example returns all watchers posted to issue TEST-001. - .EXAMPLE - Get-JiraIssue TEST-002 | Get-JiraIssueWatcher - This example illustrates use of the pipeline to return all watchers on issue TEST-002. - .INPUTS - This function can accept JiraPS.Issue objects, Strings, or Objects via the pipeline. It uses Get-JiraIssue to identify the issue parameter; see its Inputs section for details on how this function handles inputs. - .OUTPUTS - This function outputs all JiraPS.Watchers issues associated with the provided issue. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding()] param( - # JIRA issue to check for watchers. Can be a JiraPS.Issue object, issue key, or internal issue ID. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -47,8 +28,6 @@ [Object] $Issue, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraPriority.ps1 b/JiraPS/Public/Get-JiraPriority.ps1 index a97b451f..784bad8c 100644 --- a/JiraPS/Public/Get-JiraPriority.ps1 +++ b/JiraPS/Public/Get-JiraPriority.ps1 @@ -1,31 +1,10 @@ function Get-JiraPriority { - <# - .SYNOPSIS - Returns information about the available priorities in JIRA. - .DESCRIPTION - This function retrieves all the available Priorities on the JIRA server an returns them as JiraPS.Priority. - - This function can restrict the output to a subset of the available IssueTypes if told so. - .EXAMPLE - Get-JiraPriority - This example returns all the IssueTypes on the JIRA server. - .EXAMPLE - Get-JiraPriority -ID 1 - This example returns only the Priority with ID 1. - .OUTPUTS - This function outputs the JiraPS.Priority object retrieved. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( DefaultParameterSetName = '_All' )] param( - # ID of the priority to get. [Parameter( Position = 0, Mandatory, ValueFromPipeline, ParameterSetName = '_Search' )] [Int[]] $Id, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraProject.ps1 b/JiraPS/Public/Get-JiraProject.ps1 index a976047c..195a9fd3 100644 --- a/JiraPS/Public/Get-JiraProject.ps1 +++ b/JiraPS/Public/Get-JiraProject.ps1 @@ -1,37 +1,10 @@ function Get-JiraProject { - <# - .SYNOPSIS - Returns a project from Jira - .DESCRIPTION - This function returns information regarding a specified project from Jira. If - the Project parameter is not supplied, it will return information about all - projects the given user is authorized to view. - - The -Project parameter will accept either a project ID or a project key. - .EXAMPLE - Get-JiraProject -Project TEST -Credential $cred - Returns information about the project TEST - .EXAMPLE - Get-JiraProject 2 -Credential $cred - Returns information about the project with ID 2 - .EXAMPLE - Get-JiraProject -Credential $cred - Returns information about all projects the user is authorized to view - .INPUTS - [String[]] Project ID or project key - [PSCredential] Credentials to use to connect to Jira - .OUTPUTS - [JiraPS.Project] - #> [CmdletBinding( DefaultParameterSetName = '_All' )] param( - # The Project ID or project key of a project to search. [Parameter( Position = 0, Mandatory, ValueFromPipeline, ParameterSetName = '_Search' )] [String[]] $Project, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraRemoteLink.ps1 b/JiraPS/Public/Get-JiraRemoteLink.ps1 index e64a8821..ece03eca 100644 --- a/JiraPS/Public/Get-JiraRemoteLink.ps1 +++ b/JiraPS/Public/Get-JiraRemoteLink.ps1 @@ -1,23 +1,6 @@ function Get-JiraRemoteLink { - <# - .SYNOPSIS - Returns a remote link from a Jira issue - .DESCRIPTION - This function returns information on remote links from a JIRA issue. - .EXAMPLE - Get-JiraRemoteLink -Issue Project1-1000 -Credential $cred - Returns information about all remote links from the issue "Project1-1000" - .EXAMPLE - Get-JiraRemoteLink -Issue Project1-1000 -LinkId 100000 -Credential $cred - Returns information about a specific remote link from the issue "Project1-1000" - .INPUTS - [Object[]] The issue to look up in JIRA. This can be a String or a JiraPS.Issue object. - .OUTPUTS - [JiraPS.Link] - #> [CmdletBinding()] param( - # The Issue Object or ID to link. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -45,12 +28,9 @@ function Get-JiraRemoteLink { [Object] $Issue, - # Get a single link by it's id. [Int] $LinkId, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraServerInformation.ps1 b/JiraPS/Public/Get-JiraServerInformation.ps1 index b6cd78ca..0f1cbb6b 100644 --- a/JiraPS/Public/Get-JiraServerInformation.ps1 +++ b/JiraPS/Public/Get-JiraServerInformation.ps1 @@ -1,23 +1,6 @@ function Get-JiraServerInformation { - <# - .SYNOPSIS - This function returns the information about the JIRA Server - .DESCRIPTION - This functions shows all the information about the JIRA server, such as version, time, etc - .EXAMPLE - Get-JiraServerInformation - This example returns information about the JIRA server. - .INPUTS - - .OUTPUTS - [JiraPS.ServerInfo] - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding()] param( - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraSession.ps1 b/JiraPS/Public/Get-JiraSession.ps1 index 2423ddd9..4e53f9ba 100644 --- a/JiraPS/Public/Get-JiraSession.ps1 +++ b/JiraPS/Public/Get-JiraSession.ps1 @@ -1,19 +1,4 @@ function Get-JiraSession { - <# - .SYNOPSIS - Obtains a reference to the currently saved JIRA session - .DESCRIPTION - This functio obtains a reference to the currently saved JIRA session. This can provide - a JIRA session ID, as well as the username used to connect to JIRA. - .EXAMPLE - New-JiraSession -Credential (Get-Credential jiraUsername) - Get-JiraSession - Creates a Jira session for jiraUsername, then obtains a reference to it. - .INPUTS - None - .OUTPUTS - [JiraPS.Session] An object representing the Jira session - #> [CmdletBinding()] param() diff --git a/JiraPS/Public/Get-JiraUser.ps1 b/JiraPS/Public/Get-JiraUser.ps1 index 86ba14d1..2a741066 100644 --- a/JiraPS/Public/Get-JiraUser.ps1 +++ b/JiraPS/Public/Get-JiraUser.ps1 @@ -1,42 +1,18 @@ function Get-JiraUser { - <# - .SYNOPSIS - Returns a user from Jira - .DESCRIPTION - This function returns information regarding a specified user from Jira. - .EXAMPLE - Get-JiraUser -UserName user1 -Credential $cred - Returns information about the user user1 - .EXAMPLE - Get-ADUser -filter "Name -like 'John*Smith'" | Select-Object -ExpandProperty samAccountName | Get-JiraUser -Credential $cred - This example searches Active Directory for the username of John W. Smith, John H. Smith, - and any other John Smiths, then obtains their JIRA user accounts. - .INPUTS - [String[]] Username - [PSCredential] Credentials to use to connect to Jira - .OUTPUTS - [JiraPS.User] - #> [CmdletBinding( DefaultParameterSetName = 'ByUserName' )] param( - # Username, name, or e-mail address of the user. Any of these should - # return search results from Jira. [Parameter( Position = 0, Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'ByUserName' )] [ValidateNotNullOrEmpty()] [Alias('User', 'Name')] [String[]] $UserName, - # User Object of the user. [Parameter( Position = 0, Mandatory, ParameterSetName = 'ByInputObject' )] [Object[]] $InputObject, - # Include inactive users in the search [Switch] $IncludeInactive, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Get-JiraVersion.ps1 b/JiraPS/Public/Get-JiraVersion.ps1 index e2a28331..9e00ba9b 100644 --- a/JiraPS/Public/Get-JiraVersion.ps1 +++ b/JiraPS/Public/Get-JiraVersion.ps1 @@ -1,66 +1,29 @@ function Get-JiraVersion { - <# - .SYNOPSIS - This function returns information about a JIRA Project's Version - .DESCRIPTION - This function provides information about JIRA Version - .EXAMPLE - Get-JiraVersion -Project $ProjectKey - This example returns information about all JIRA Version visible to the current user for the project. - .EXAMPLE - Get-JiraVersion -Project $ProjectKey -Name '1.0.0.0' - This example returns the information of a specific Version. - .EXAMPLE - Get-JiraProject "FOO", "BAR" | Get-JiraVersion -Name "v1.0", "v2.0" - Get the Version with name "v1.0" and "v2.0" from both projects "FOO" and "BAR" - .EXAMPLE - Get-JiraVersion -ID '66596' - This example returns information about all JIRA Version visible to the current user (or using anonymous access if a JiraPS session has not been defined) for the project. - .INPUTS - [JiraPS.Version] - [JiraPS.Project] - .OUTPUTS - [JiraPS.Version] - .LINK - Get-JiraProject - New-JiraVersion - Set-JiraVersion - Remove-JiraVersion - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( DefaultParameterSetName = 'byId' )] param( - # The Version ID [Parameter( Mandatory, ParameterSetName = 'byId' )] [Int[]] $Id, - # A Version object to search for [Parameter( Position = 0, Mandatory, ValueFromPipeline, ParameterSetName = 'byInputVersion' )] [PSTypeName('JiraPS.Version')] $InputVersion, - # Project key of a project to search [Parameter( Position = 0, Mandatory , ParameterSetName = 'byProject' )] [Alias('Key')] [String[]] $Project, - # A Project Object to search [Parameter( Position = 0, Mandatory, ValueFromPipeline, ParameterSetName = 'byInputProject' )] [PSTypeName('JiraPS.Project')] $InputProject, - # Jira Version Name [Parameter( ParameterSetName = 'byProject' )] [Parameter( ParameterSetName = 'byInputProject' )] [Alias('Versions')] [String[]] $Name, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Invoke-JiraIssueTransition.ps1 b/JiraPS/Public/Invoke-JiraIssueTransition.ps1 index dbe5c158..84467ef9 100644 --- a/JiraPS/Public/Invoke-JiraIssueTransition.ps1 +++ b/JiraPS/Public/Invoke-JiraIssueTransition.ps1 @@ -1,44 +1,6 @@ function Invoke-JiraIssueTransition { - <# - .SYNOPSIS - Performs an issue transition on a JIRA issue, changing its status - .DESCRIPTION - This function performs an issue transition on a JIRA issue. Transitions are - defined in JIRA through workflows, and allow the issue to move from one status - to the next. For example, the "Start Progress" transition typically moves - an issue from an Open status to an "In Progress" status. - - To identify the transitions that an issue can perform, use Get-JiraIssue and - check the Transition property of the issue obj ect returned. Attempting to - perform a transition that does not apply to the issue (for example, trying - to "start progress" on an issue in progress) will result in an exception. - .EXAMPLE - Invoke-JiraIssueTransition -Issue TEST-01 -Transition 11 - Invokes transition ID 11 on issue TEST-01. - .EXAMPLE - Invoke-JiraIssueTransition -Issue TEST-01 -Transition 11 -Comment 'Transition comment' - Invokes transition ID 11 on issue TEST-01 with a comment. Requires the comment field to be configured visible for transition. - .EXAMPLE - Invoke-JiraIssueTransition -Issue TEST-01 -Transition 11 -Assignee 'joe.bloggs' - Invokes transition ID 11 on issue TEST-01 and assigns to user 'Joe Blogs'. Requires the assignee field to be configured as visible for transition. - .EXAMPLE - $transitionFields = @{'customfield_12345' = 'example'} - Invoke-JiraIssueTransition -Issue TEST-01 -Transition 11 -Fields $transitionFields - Invokes transition ID 11 on issue TEST-01 and configures a custom field value. Requires fields to be configured as visible for transition. - .EXAMPLE - $transition = Get-JiraIssue -Issue TEST-01 | Select-Object -ExpandProperty Transition | ? {$_.ResultStatus.Name -eq 'In Progress'} - Invoke-JiraIssueTransition -Issue TEST-01 -Transition $transition - This example identifies the correct transition based on the result status of - "In Progress," and invokes that transition on issue TEST-01. - .INPUTS - [JiraPS.Issue] Issue (can also be provided as a String) - [JiraPS.Transition] Transition to perform (can also be provided as an int ID) - .OUTPUTS - This function does not provide output. - #> [CmdletBinding()] param( - # The Issue Object or ID to transition. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -66,32 +28,19 @@ function Invoke-JiraIssueTransition { [Object] $Issue, - # The Transition Object or ID. [Parameter( Mandatory )] [Object] $Transition, - # Any additional fields that should be updated. - # - # Fields must be configured to appear on the transition screen to use this parameter. [System.Collections.Hashtable] $Fields, - # New assignee of the issue - # - # Enter 'Unassigned' to unassign the issue. - # Assignee field must be configured to appear on the transition screen to use this parameter. [Object] $Assignee, - # Comment that should be added to JIRA. - # - # Comment field must be configured to appear on the transition screen to use this parameter. [String] $Comment, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/New-JiraGroup.ps1 b/JiraPS/Public/New-JiraGroup.ps1 index 0d67f6cd..e2f9a94b 100644 --- a/JiraPS/Public/New-JiraGroup.ps1 +++ b/JiraPS/Public/New-JiraGroup.ps1 @@ -1,27 +1,11 @@ function New-JiraGroup { - <# - .SYNOPSIS - Creates a new group in JIRA - .DESCRIPTION - This function creates a new group in JIRA. - .EXAMPLE - New-JiraGroup -GroupName testGroup - This example creates a new JIRA group named testGroup. - .INPUTS - This function does not accept pipeline input. - .OUTPUTS - [JiraPS.Group] The user object created - #> [CmdletBinding( SupportsShouldProcess )] param( - # Name for the new group. [Parameter( Mandatory )] [Alias('Name')] [String[]] $GroupName, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/New-JiraIssue.ps1 b/JiraPS/Public/New-JiraIssue.ps1 index 658b470b..096287b0 100644 --- a/JiraPS/Public/New-JiraIssue.ps1 +++ b/JiraPS/Public/New-JiraIssue.ps1 @@ -1,82 +1,42 @@ function New-JiraIssue { - <# - .SYNOPSIS - Creates an issue in JIRA - .DESCRIPTION - This function creates a new issue in JIRA. - - Creating an issue requires a lot of data, and the exact data may be - different from one instance of JIRA to the next. To identify what data - is required for a given issue type and project, use the - Get-JiraIssueCreateMetadata function provided in this module. - - Some JIRA instances may require additional custom fields specific to that - instance of JIRA. In addition to the parameterized fields provided in - this function, the Fields parameter accepts a hashtable of field names / - IDs and values. This allows users to provide custom field data when - creating an issue. - .EXAMPLE - Get-JiraIssueCreateMetadata -Project TEST -IssueType Bug | ? {$_.Required -eq $true} - New-JiraIssue -Project TEST -IssueType Bug -Priority 1 -Summary 'Test issue from PowerShell' -Description 'This is a test issue created from the JiraPS module in PowerShell.' -Fields {'Custom Field Name 1'='foo';'customfield_10001'='bar';} - This example uses Get-JiraIssueCreateMetadata to identify fields required - to create an issue in JIRA. It then creates an issue with the Fields parameter - providing a field name and a field ID. - .INPUTS - This function does not accept pipeline input. - .OUTPUTS - [JiraPS.Issue] The issue created in JIRA. - #> [CmdletBinding( SupportsShouldProcess )] param( - # Project in which to create the issue. [Parameter( Mandatory )] [String] $Project, - # Type of the issue. [Parameter( Mandatory )] [String] $IssueType, - # Summary of the issue. [Parameter( Mandatory )] [String] $Summary, - # ID of the Priority the issue shall have. [Int] $Priority, - # Long description of the issue. [String] $Description, - # User that shall be registed as the reporter. - # If left empty, the currently authenticated user will be used. [AllowNull()] [AllowEmptyString()] [String] $Reporter, - # List of labels which will be added to the issue. [String[]] $Labels, - # Parent issue - in case of "Sub-Tasks". [String] $Parent, - # Set the FixVersion of the issue. [Alias('FixVersions')] [String[]] $FixVersion, - # Any additional fields. [Hashtable] $Fields, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/New-JiraSession.ps1 b/JiraPS/Public/New-JiraSession.ps1 index f3998ba0..26173afb 100644 --- a/JiraPS/Public/New-JiraSession.ps1 +++ b/JiraPS/Public/New-JiraSession.ps1 @@ -1,35 +1,11 @@ function New-JiraSession { - <# - .SYNOPSIS - Creates a persistent JIRA authenticated session which can be used by other JiraPS functions - .DESCRIPTION - This function creates a persistent, authenticated session in to JIRA which can be used by all other - JiraPS functions instead of explicitly passing parameters. This removes the need to use the - -Credential parameter constantly for each function call. - - This is the equivalent of a browser cookie saving login information. - - Session data is stored in this module's PrivateData; it is not necessary to supply it to each - subsequent function. - .EXAMPLE - New-JiraSession -Credential (Get-Credential jiraUsername) - Get-JiraIssue TEST-01 - Creates a Jira session for jiraUsername. The following Get-JiraIssue is run using the - saved session for jiraUsername. - .INPUTS - [PSCredential] The credentials to use to create the Jira session - .OUTPUTS - [JiraPS.Session] An object representing the Jira session - #> [CmdletBinding()] [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')] param( - # Credentials to use to connect to JIRA. [Parameter( Mandatory )] [PSCredential] $Credential, - # Additional Headers [Hashtable] $Headers = @{} ) diff --git a/JiraPS/Public/New-JiraUser.ps1 b/JiraPS/Public/New-JiraUser.ps1 index 776e6d8a..774fa71d 100644 --- a/JiraPS/Public/New-JiraUser.ps1 +++ b/JiraPS/Public/New-JiraUser.ps1 @@ -1,49 +1,21 @@ function New-JiraUser { - <# - .SYNOPSIS - Creates a new user in JIRA - .DESCRIPTION - This function creates a new user in JIRA. By default, the new user - will be notified via e-mail. - - The new user's password is also randomly generated. - .EXAMPLE - New-JiraUser -UserName testUser -EmailAddress testUser@example.com - This example creates a new JIRA user named testUser, and sends a - notification e-mail. The user's DisplayName will be set to - "testUser" since it is not specified. - .EXAMPLE - New-JiraUser -UserName testUser2 -EmailAddress testUser2@example.com -DisplayName "Test User 2" - This example illustrates setting a user's display name during - user creation. - .INPUTS - This function does not accept pipeline input. - .OUTPUTS - [JiraPS.User] The user object created - #> [CmdletBinding( SupportsShouldProcess )] param( - # Name of user. [Parameter( Mandatory )] [String] $UserName, - # E-mail address of the user. [Parameter( Mandatory )] [Alias('Email')] [String] $EmailAddress, - # Display name of the user. [String] $DisplayName, - # Should the user receive a notification e-mail? [Boolean] $Notify = $true, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/New-JiraVersion.ps1 b/JiraPS/Public/New-JiraVersion.ps1 index 878f7603..fef2e100 100644 --- a/JiraPS/Public/New-JiraVersion.ps1 +++ b/JiraPS/Public/New-JiraVersion.ps1 @@ -1,43 +1,6 @@ function New-JiraVersion { - <# - .SYNOPSIS - Creates a new FixVersion in JIRA - .DESCRIPTION - This function creates a new FixVersion in JIRA. - .EXAMPLE - New-JiraVersion -Name '1.0.0.0' -Project "RD" - Description - ----------- - This example creates a new JIRA Version named '1.0.0.0' in project `RD`. - .EXAMPLE - $project = Get-JiraProject -Project "RD" - New-JiraVersion -Name '1.0.0.0' -Project $project -ReleaseDate "2000-12-31" - Description - ----------- - Create a new Version in Project `RD` with a set release date. - .EXAMPLE - $version = Get-JiraVersion -Name "1.0.0.0" -Project "RD" - $version = $version.Project.Key "TEST" - $version | New-JiraVersion - Description - ----------- - This example duplicates the Version named '1.0.0.0' in Project `RD` to Project `TEST`. - .OUTPUTS - [JiraPS.Version] - .LINK - Get-JiraVersion - .LINK - Remove-JiraVersion - .LINK - Set-JiraVersion - .LINK - Get-JiraProject - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( SupportsShouldProcess, DefaultParameterSetName = 'byObject' )] param( - # Version object that should be created on the server. [Parameter( Position = 0, Mandatory, ValueFromPipeline, ParameterSetName = 'byObject' )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -64,12 +27,10 @@ [Object] $InputObject, - # Name of the version to create. [Parameter( Position = 0, Mandatory, ParameterSetName = 'byParameters' )] [String] $Name, - # The Project ID [Parameter( Position = 1, Mandatory, ParameterSetName = 'byParameters' )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -99,33 +60,26 @@ [Object] $Project, - # Description of the version. [Parameter( ParameterSetName = 'byParameters' )] [String] $Description, - # Create the version as archived. [Parameter( ParameterSetName = 'byParameters' )] [Bool] $Archived, - # Create the version as released. [Parameter( ParameterSetName = 'byParameters' )] [Bool] $Released, - # Date of the release. [Parameter( ParameterSetName = 'byParameters' )] [DateTime] $ReleaseDate, - # Date of the release. [Parameter( ParameterSetName = 'byParameters' )] [DateTime] $StartDate, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Remove-JiraGroup.ps1 b/JiraPS/Public/Remove-JiraGroup.ps1 index 76de3bec..92ff06cc 100644 --- a/JiraPS/Public/Remove-JiraGroup.ps1 +++ b/JiraPS/Public/Remove-JiraGroup.ps1 @@ -1,22 +1,6 @@ function Remove-JiraGroup { - <# - .SYNOPSIS - Removes an existing group from JIRA - .DESCRIPTION - This function removes an existing group from JIRA. - - Deleting a group does not delete users from JIRA. - .EXAMPLE - Remove-JiraGroup -GroupName testGroup - Removes the JIRA group testGroup - .INPUTS - [JiraPS.Group[]] The JIRA groups to delete - .OUTPUTS - This function returns no output. - #> [CmdletBinding( SupportsShouldProcess, ConfirmImpact = 'High' )] param( - # Group Object or ID to delete. [Parameter( Mandatory, ValueFromPipeline )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -44,12 +28,9 @@ [Object[]] $Group, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Suppress user confirmation. [Switch] $Force ) diff --git a/JiraPS/Public/Remove-JiraGroupMember.ps1 b/JiraPS/Public/Remove-JiraGroupMember.ps1 index ef95312a..28f1f70e 100644 --- a/JiraPS/Public/Remove-JiraGroupMember.ps1 +++ b/JiraPS/Public/Remove-JiraGroupMember.ps1 @@ -1,30 +1,6 @@ function Remove-JiraGroupMember { - <# - .SYNOPSIS - Removes a user from a JIRA group - .DESCRIPTION - This function removes a JIRA user from a JIRA group. - .EXAMPLE - Remove-JiraGroupMember -Group testUsers -User jsmith - This example removes the user jsmith from the group testUsers. - .EXAMPLE - Get-JiraGroup 'Project Admins' | Remove-JiraGroupMember -User jsmith - This example illustrates the use of the pipeline to remove jsmith from - the "Project Admins" group in JIRA. - .INPUTS - [JiraPS.Group[]] Group(s) from which users should be removed - .OUTPUTS - If the -PassThru parameter is provided, this function will provide a - reference to the JIRA group modified. Otherwise, this function does not - provide output. - .NOTES - This REST method is still marked Experimental in JIRA's REST API. That - means that there is a high probability this will break in future - versions of JIRA. The function will need to be re-written at that time. - #> [CmdletBinding( SupportsShouldProcess, ConfirmImpact = 'High' )] param( - # Group Object or ID from which to remove the user(s). [Parameter( Mandatory, ValueFromPipeline )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -52,7 +28,6 @@ function Remove-JiraGroupMember { [Object[]] $Group, - # Username or user object obtained from Get-JiraUser [Parameter( Mandatory )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -80,16 +55,12 @@ function Remove-JiraGroupMember { [Object[]] $User, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Whether output should be provided after invoking this function [Switch] $PassThru, - # Suppress user confirmation. [Switch] $Force ) diff --git a/JiraPS/Public/Remove-JiraIssueAttachment.ps1 b/JiraPS/Public/Remove-JiraIssueAttachment.ps1 index 7bc53f94..cb9c8ca0 100644 --- a/JiraPS/Public/Remove-JiraIssueAttachment.ps1 +++ b/JiraPS/Public/Remove-JiraIssueAttachment.ps1 @@ -1,31 +1,12 @@ function Remove-JiraIssueAttachment { - <# - .SYNOPSIS - Removes an attachment from a JIRA issue - .DESCRIPTION - This function removes an attachment from a JIRA issue. - .EXAMPLE - Remove-JiraIssueAttachment -AttachmentId 10039 - Removes attachment with id of 10039 - .EXAMPLE - Get-JiraIssueAttachment -Issue FOO-1234 | Remove-JiraIssueAttachment - Removes all attachments from issue FOO-1234 - .EXAMPLE - Remove-JiraIssueAttachment -Issue FOO-1234 -FileName '*.png' -force - Removes all *.png attachments from Issue FOO-1234 without prompting for confirmation - .OUTPUTS - This function returns no output. - #> [CmdletBinding( ConfirmImpact = 'High', SupportsShouldProcess, DefaultParameterSetName = 'byId' )] param( - # Id of the Attachment to delete [Parameter( Position = 0, Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'byId' )] [ValidateNotNullOrEmpty()] [Alias('Id')] [Int[]] $AttachmentId, - # Issue from which to delete on or more attachments [Parameter( Position = 0, Mandatory, ParameterSetName = 'byIssue' )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -53,17 +34,13 @@ function Remove-JiraIssueAttachment { [Object] $Issue, - # Name of the File to delete [Parameter( ParameterSetName = 'byIssue' )] [String[]] $FileName, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Suppress user confirmation. [Switch] $Force ) diff --git a/JiraPS/Public/Remove-JiraIssueLink.ps1 b/JiraPS/Public/Remove-JiraIssueLink.ps1 index ec1deb69..48be0107 100644 --- a/JiraPS/Public/Remove-JiraIssueLink.ps1 +++ b/JiraPS/Public/Remove-JiraIssueLink.ps1 @@ -1,24 +1,6 @@ function Remove-JiraIssueLink { - <# - .SYNOPSIS - Removes a issue link from a JIRA issue - .DESCRIPTION - This function removes a issue link from a JIRA issue. - .EXAMPLE - Remove-JiraIssueLink 1234,2345 - Removes two issue links with id 1234 and 2345 - .EXAMPLE - Get-JiraIssue -Query "project = Project1 AND label = lingering" | Remove-JiraIssueLink - Removes all issue links for all issues in project Project1 and that have a label "lingering" - .INPUTS - [JiraPS.IssueLink[]] The JIRA issue link which to delete - .OUTPUTS - This function returns no output. - #> [CmdletBinding( SupportsShouldProcess, ConfirmImpact = 'Medium' )] param( - # IssueLink to delete - # If an Issue is provided, all issueLinks will be deleted. [Parameter( Mandatory, ValueFromPipeline )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -48,8 +30,6 @@ function Remove-JiraIssueLink { [Object[]] $IssueLink, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Remove-JiraIssueWatcher.ps1 b/JiraPS/Public/Remove-JiraIssueWatcher.ps1 index c8d16756..bf5a66a3 100644 --- a/JiraPS/Public/Remove-JiraIssueWatcher.ps1 +++ b/JiraPS/Public/Remove-JiraIssueWatcher.ps1 @@ -1,33 +1,10 @@ function Remove-JiraIssueWatcher { - <# - .SYNOPSIS - Removes a watcher from an existing JIRA issue - .DESCRIPTION - This function removes a watcher from an existing issue in JIRA. - .EXAMPLE - Remove-JiraIssueWatcher -Watcher "fred" -Issue "TEST-001" - This example removes a watcher from the issue TEST-001. - .EXAMPLE - Get-JiraIssue "TEST-002" | Remove-JiraIssueWatcher "fred" - This example illustrates pipeline use from Get-JiraIssue to Remove-JiraIssueWatcher. - .EXAMPLE - Get-JiraIssue -Query 'project = "TEST" AND created >= -5d' | % { Remove-JiraIssueWatcher "fred" } - This example illustrates removing watcher on all projects which match a given JQL query. It would be best to validate the query first to make sure the query returns the expected issues! - .INPUTS - This function can accept JiraPS.Issue objects via pipeline. - .OUTPUTS - This function does not provide output. - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( SupportsShouldProcess )] param( - # Watcher that should be removed from JIRA [Parameter( Mandatory )] [string[]] $Watcher, - # Issue that should be updated [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -55,8 +32,6 @@ [Object] $Issue, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential ) diff --git a/JiraPS/Public/Remove-JiraRemoteLink.ps1 b/JiraPS/Public/Remove-JiraRemoteLink.ps1 index add86b64..7f82c003 100644 --- a/JiraPS/Public/Remove-JiraRemoteLink.ps1 +++ b/JiraPS/Public/Remove-JiraRemoteLink.ps1 @@ -1,23 +1,6 @@ function Remove-JiraRemoteLink { - <# - .SYNOPSIS - Removes a remote link from a JIRA issue - .DESCRIPTION - This function removes a remote link from a JIRA issue. - .EXAMPLE - Remove-JiraRemoteLink Project1-1001 10000,20000 - Removes two remote link from issue "Project1-1001" - .EXAMPLE - Get-JiraIssue -Query "project = Project1" | Remove-JiraRemoteLink 10000 - Removes a specific remote link from all issues in project "Project1" - .INPUTS - [JiraPS.Issue[]] The JIRA issue from which to delete a link - .OUTPUTS - This function returns no output. - #> [CmdletBinding( ConfirmImpact = 'High', SupportsShouldProcess )] param( - # Issue from which to delete a remote link. [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -45,17 +28,13 @@ function Remove-JiraRemoteLink { [Object[]] $Issue, - # Id of the remote link to delete. [Parameter( Mandatory )] [Int[]] $LinkId, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Suppress user confirmation. [Switch] $Force ) diff --git a/JiraPS/Public/Remove-JiraSession.ps1 b/JiraPS/Public/Remove-JiraSession.ps1 index 87818dd1..08cd039e 100644 --- a/JiraPS/Public/Remove-JiraSession.ps1 +++ b/JiraPS/Public/Remove-JiraSession.ps1 @@ -1,37 +1,7 @@ function Remove-JiraSession { - <# - .SYNOPSIS - Removes a persistent JIRA authenticated session - .DESCRIPTION - This function removes a persistent JIRA authenticated session and closes the session for JIRA. - This can be used to "log out" of JIRA once work is complete. - - If called with the Session parameter, this function will attempt to close the provided - JiraPS.Session object. - - If called with no parameters, this function will close the saved JIRA session in the module's - PrivateData. - .EXAMPLE - New-JiraSession -Credential (Get-Credential jiraUsername) - Get-JiraIssue TEST-01 - Remove-JiraSession - This example creates a JIRA session for jiraUsername, runs Get-JiraIssue, and closes the JIRA session. - .EXAMPLE - $s = New-JiraSession -Credential (Get-Credential jiraUsername) - Remove-JiraSession $s - This example creates a JIRA session and saves it to a variable, then uses the variable reference to - close the session. - .INPUTS - [JiraPS.Session] A Session object to close. - .OUTPUTS - [JiraPS.Session] An object representing the Jira session - #> [CmdletBinding()] [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')] param( - # A Jira session to be closed. If not specified, this function will use a saved session. - # - # This parameter has currently no meaning. [Parameter( ValueFromPipeline )] [Object] $Session diff --git a/JiraPS/Public/Remove-JiraUser.ps1 b/JiraPS/Public/Remove-JiraUser.ps1 index cc8e4bdc..a7628322 100644 --- a/JiraPS/Public/Remove-JiraUser.ps1 +++ b/JiraPS/Public/Remove-JiraUser.ps1 @@ -1,25 +1,6 @@ function Remove-JiraUser { - <# - .SYNOPSIS - Removes an existing user from JIRA - .DESCRIPTION - This function removes an existing user from JIRA. - - WARNING: Deleting a JIRA user may cause database integrity problems. See this article for - details: - - https://confluence.atlassian.com/jira/how-do-i-delete-a-user-account-192519.html - .EXAMPLE - Remove-JiraUser -UserName testUser - Removes the JIRA user TestUser - .INPUTS - [JiraPS.User[]] The JIRA users to delete - .OUTPUTS - This function returns no output. - #> [CmdletBinding( ConfirmImpact = 'High', SupportsShouldProcess )] param( - # User Object or ID to delete. [Parameter( Mandatory, ValueFromPipeline )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -47,12 +28,9 @@ function Remove-JiraUser { [Object[]] $User, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Suppress user confirmation. [Switch] $Force ) diff --git a/JiraPS/Public/Remove-JiraVersion.ps1 b/JiraPS/Public/Remove-JiraVersion.ps1 index bdbcf7ee..94c0ebcc 100644 --- a/JiraPS/Public/Remove-JiraVersion.ps1 +++ b/JiraPS/Public/Remove-JiraVersion.ps1 @@ -1,31 +1,6 @@ function Remove-JiraVersion { - <# - .SYNOPSIS - This function removes an existing version. - .DESCRIPTION - This function removes an existing version in JIRA. - .EXAMPLE - Get-JiraVersion -Name '1.0.0.0' -Project $Project | Remove-JiraVersion - This example removes the Version given. - .EXAMPLE - Remove-JiraVersion -Version '66596' - This example removes the Version given. - .INPUTS - [JiraPS.Version] - .OUTPUTS - This Function outputs no results - .LINK - New-JiraVersion - .LINK - Get-JiraVersion - .LINK - Set-JiraVersion - .NOTES - This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA. - #> [CmdletBinding( ConfirmImpact = 'High', SupportsShouldProcess )] param( - # Version Object or ID to delete. [Parameter( Mandatory, ValueFromPipeline )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -52,12 +27,9 @@ [Object[]] $Version, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Suppress user confirmation. [Switch] $Force ) diff --git a/JiraPS/Public/Set-JiraConfigServer.ps1 b/JiraPS/Public/Set-JiraConfigServer.ps1 index 38c2fa72..7fad90cf 100644 --- a/JiraPS/Public/Set-JiraConfigServer.ps1 +++ b/JiraPS/Public/Set-JiraConfigServer.ps1 @@ -1,33 +1,13 @@ function Set-JiraConfigServer { - <# - .SYNOPSIS - Defines the configured URL for the JIRA server - .DESCRIPTION - This function defines the configured URL for the JIRA server that JiraPS should manipulate. By default, this is stored in a config.xml file at the module's root path. - .EXAMPLE - Set-JiraConfigServer 'https://jira.example.com:8080' - This example defines the server URL of the JIRA server configured in the JiraPS config file. - .EXAMPLE - Set-JiraConfigServer -Server 'https://jira.example.com:8080' -ConfigFile C:\jiraconfig.xml - This example defines the server URL of the JIRA server configured at C:\jiraconfig.xml. - .INPUTS - This function does not accept pipeline input. - .OUTPUTS - [System.String] - .NOTES - Support for multiple configuration files is limited at this point in time, but enhancements are planned for a future update. - #> [CmdletBinding()] [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')] param( - # The base URL of the Jira instance. [Parameter( Mandatory )] [ValidateNotNullOrEmpty()] [Alias('Uri')] [Uri] $Server, - # Path where the file with the configuration will be stored. [String] $ConfigFile ) diff --git a/JiraPS/Public/Set-JiraIssue.ps1 b/JiraPS/Public/Set-JiraIssue.ps1 index 8135a935..d747a000 100644 --- a/JiraPS/Public/Set-JiraIssue.ps1 +++ b/JiraPS/Public/Set-JiraIssue.ps1 @@ -1,33 +1,6 @@ function Set-JiraIssue { - <# - .SYNOPSIS - Modifies an existing issue in JIRA - .DESCRIPTION - This function modifies an existing isue in JIRA. This can include changing - the issue's summary or description, or assigning the issue. - .EXAMPLE - Set-JiraIssue -Issue TEST-01 -Summary 'Modified issue summary' -Description 'This issue has been modified by PowerShell' - This example changes the summary and description of the JIRA issue TEST-01. - .EXAMPLE - $issue = Get-JiraIssue TEST-01 - $issue | Set-JiraIssue -Description "$($issue.Description)`n`nEdit: Also foo." - This example appends text to the end of an existing issue description by using - Get-JiraIssue to obtain a reference to the current issue and description. - .EXAMPLE - Set-JiraIssue -Issue TEST-01 -Assignee 'Unassigned' - This example removes the assignee from JIRA issue TEST-01. - .EXAMPLE - Set-JiraIssue -Issue TEST-01 -Assignee 'joe' -AddComment 'Dear [~joe], please review.' - This example assigns the JIRA Issue TEST-01 to 'joe' and adds a comment at one. - .INPUTS - [JiraPS.Issue[]] The JIRA issue that should be modified - .OUTPUTS - If the -PassThru parameter is provided, this function will provide a reference - to the JIRA issue modified. Otherwise, this function does not provide output. - #> [CmdletBinding( SupportsShouldProcess )] param( - # Issue key or JiraPS.Issue object returned from Get-JiraIssue [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -55,43 +28,31 @@ function Set-JiraIssue { [Object[]] $Issue, - # New summary of the issue. [String] $Summary, - # New description of the issue. [String] $Description, - # Set the FixVersion of the issue, this will overwrite any present FixVersions [Alias('FixVersions')] [String[]] $FixVersion, - # New assignee of the issue. Enter 'Unassigned' to unassign the issue. [Object] $Assignee, - # Labels to be set on the issue. These wil overwrite any existing - # labels on the issue. For more granular control over issue labels, - # use Set-JiraIssueLabel. [String[]] $Label, - # Any additional fields that should be updated. [Hashtable] $Fields, - # Add a comment ad once with your changes [String] $AddComment, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Whether output should be provided after invoking this function. [Switch] $PassThru ) diff --git a/JiraPS/Public/Set-JiraIssueLabel.ps1 b/JiraPS/Public/Set-JiraIssueLabel.ps1 index 23d7e096..dcf272bf 100644 --- a/JiraPS/Public/Set-JiraIssueLabel.ps1 +++ b/JiraPS/Public/Set-JiraIssueLabel.ps1 @@ -1,36 +1,6 @@ function Set-JiraIssueLabel { - <# - .SYNOPSIS - Modifies labels on an existing JIRA issue - .DESCRIPTION - This function modifies labels on an existing JIRA issue. There are - four supported operations on labels: - - * Add: appends additional labels to the labels that an issue already has - * Remove: Removes labels from an issue's current labels - * Set: erases the existing labels on the issue and replaces them with - the provided values - * Clear: removes all labels from the issue - .EXAMPLE - Set-JiraIssueLabel -Issue TEST-01 -Set 'fixed' - This example replaces all existing labels on issue TEST-01 with one - label, "fixed". - .EXAMPLE - Get-JiraIssue -Query 'created >= -7d AND reporter in (joeSmith)' | Set-JiraIssueLabel -Add 'enhancement' - This example adds the "enhancement" label to all issues matching the JQL - in this case, - all issues created by user joeSmith in the last 7 days. - .EXAMPLE - Get-JiraIssue TEST-01 | Set-JiraIssueLabel -Clear - This example removes all labels from the issue TEST-01. - .INPUTS - [JiraPS.Issue[]] The JIRA issue that should be modified - .OUTPUTS - If the -PassThru parameter is provided, this function will provide a reference - to the JIRA issue modified. Otherwise, this function does not provide output. - #> [CmdletBinding( SupportsShouldProcess, DefaultParameterSetName = 'ReplaceLabels' )] param( - # Issue key or JiraPS.Issue object returned from Get-JiraIssue [Parameter( Position = 0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -58,34 +28,26 @@ [Object[]] $Issue, - # List of labels that will be set to the issue. - # Any label that was already assigned to the issue will be removed. [Parameter( Mandatory, ParameterSetName = 'ReplaceLabels' )] [Alias('Label', 'Replace')] [String[]] $Set, - # Existing labels to be added. [Parameter( ParameterSetName = 'ModifyLabels' )] [String[]] $Add, - # Existing labels to be removed. [Parameter( ParameterSetName = 'ModifyLabels' )] [String[]] $Remove, - # Remove all labels. [Parameter( Mandatory, ParameterSetName = 'ClearLabels' )] [Switch] $Clear, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Whether output should be provided after invoking this function. [Switch] $PassThru ) diff --git a/JiraPS/Public/Set-JiraUser.ps1 b/JiraPS/Public/Set-JiraUser.ps1 index fbedf096..02675c94 100644 --- a/JiraPS/Public/Set-JiraUser.ps1 +++ b/JiraPS/Public/Set-JiraUser.ps1 @@ -1,32 +1,6 @@ function Set-JiraUser { - <# - .SYNOPSIS - Modifies user properties in JIRA - .DESCRIPTION - This function modifies user properties in JIRA, allowing you to change a user's - e-mail address, display name, and any other properties supported by JIRA's API. - .EXAMPLE - Set-JiraUser -User user1 -EmailAddress user1_new@example.com - Modifies user1's e-mail address to a new value. The original value is overridden. - .EXAMPLE - Set-JiraUser -User user2 -Properties @{EmailAddress='user2_new@example.com';DisplayName='User 2'} - This example modifies a user's properties using a hashtable. This allows updating - properties that are not exposed as parameters to this function. - .INPUTS - [JiraPS.User[]] The JIRA user that should be modified. - .OUTPUTS - If the -PassThru parameter is provided, this function will provide a reference - to the JIRA user modified. Otherwise, this function does not provide output. - .NOTES - It is currently NOT possible to enable and disable users with this function. JIRA - does not currently provide this ability via their REST API. - - If you'd like to see this ability added to JIRA and to this module, please vote on - Atlassian's site for this issue: https://jira.atlassian.com/browse/JRA-37294 - #> [CmdletBinding( SupportsShouldProcess, DefaultParameterSetName = 'ByNamedParameters' )] param( - # Username or user object obtained from Get-JiraUser. [Parameter( Position = 0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -54,13 +28,11 @@ function Set-JiraUser { [Object[]] $User, - # Display name to set. [Parameter( ParameterSetName = 'ByNamedParameters' )] [ValidateNotNullOrEmpty()] [String] $DisplayName, - # E-mail address to set. [Parameter( ParameterSetName = 'ByNamedParameters' )] [ValidateNotNullOrEmpty()] [ValidateScript( @@ -84,17 +56,13 @@ function Set-JiraUser { [String] $EmailAddress, - # Hashtable (dictionary) of additional information to set. [Parameter( Position = 1, Mandatory, ParameterSetName = 'ByHashtable' )] [Hashtable] $Property, - # Credentials to use to connect to JIRA. - # If not specified, this function will use anonymous access. [PSCredential] $Credential, - # Whether output should be provided after invoking this function. [Switch] $PassThru ) From c1d8cffa604a18992b32bbc52b4e015b063d03d2 Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Wed, 18 Apr 2018 11:40:54 +0200 Subject: [PATCH 5/7] Updated README --- README.md | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f46469d0..87d9b5de 100644 --- a/README.md +++ b/README.md @@ -23,36 +23,39 @@ Join the conversation on [![SlackLogo][] AtlassianPS.Slack.com](https://atlassia Install JiraPS from the [PowerShell Gallery]! `Install-Module` requires PowerShellGet (included in PS v5, or download for v3/v4 via the gallery link) ```powershell -# One time only install: (requires an admin PowerShell window) -Install-Module JiraPS +# One time only install: +Install-Module JiraPS -Scope CurrentUser # Check for updates occasionally: Update-Module JiraPS +``` + +### Usage +```powershell # To use each session: Import-Module JiraPS Set-JiraConfigServer 'https://YourCloud.atlassian.net' New-JiraSession -Credential $cred ``` -### Usage - You can find the full documentation on our [homepage](https://atlassianps.org/docs/JiraPS) and in the console. + ```powershell # Review the help at any time! Get-Help about_JiraPS Get-Command -Module JiraPS -Get-Help Get-JiraIssue -Full # or any other command +Get-Help Get-JiraIssue -Full # or any other command ``` -For first steps to get up and running, check out the [Getting Started](https://atlassianps.org/docs/JiraPS/Getting_Started.html) page. +For more information on how to use JiraPS, check out the [Documentation](https://atlassianps.org/docs/JiraPS/). ### Contribute Want to contribute to AtlassianPS? Great! We appreciate [everyone](https://atlassianps.org/#people) who invests their time to make our modules the best they can be. -Check out our guidelines on [Contributing](https://atlassianps.org/docs/Contributing.html) to our modules and documentation. +Check out our guidelines on [Contributing] to our modules and documentation. ## Acknowledgments @@ -64,20 +67,24 @@ Check out our guidelines on [Contributing](https://atlassianps.org/docs/Contribu * [Source Code] * [Latest Release] * [Submit an Issue] +* [Contributing] * How you can help us: [List of Issues](https://github.com/AtlassianPS/JiraPS/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs) ## Disclaimer Hopefully this is obvious, but: + > This is an open source project (under the [MIT license]), and all contributors are volunteers. All commands are executed at your own risk. Please have good backups before you start, because you can delete a lot of stuff if you're not careful. - [JIRA]: - [PowerShell Gallery]: - [Source Code]: - [Latest Release]: - [Submit an Issue]: - [replicaJunction]: - [MIT license]: + + [JIRA]: https://www.atlassian.com/software/jira + [PowerShell Gallery]: https://www.powershellgallery.com/ + [Source Code]: https://github.com/AtlassianPS/JiraPS + [Latest Release]: https://github.com/AtlassianPS/JiraPS/releases/latest + [Submit an Issue]: https://github.com/AtlassianPS/JiraPS/issues/new + [replicaJunction]: https://github.com/replicaJunction + [MIT license]: https://github.com/brianbunke/JiraPS/blob/master/LICENSE + [Contributing]: http://atlassianps.org/docs/Contributing From 9981d2d28145548340b9709810ce88ce93d0d687 Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Thu, 19 Apr 2018 09:10:11 +0200 Subject: [PATCH 6/7] Added generation of External-Help with PlatyPS to the build script --- JiraPS.build.ps1 | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/JiraPS.build.ps1 b/JiraPS.build.ps1 index c171a9e5..3584ff55 100644 --- a/JiraPS.build.ps1 +++ b/JiraPS.build.ps1 @@ -117,7 +117,7 @@ task InstallPandoc { task Build GenerateRelease, ConvertMarkdown, UpdateManifest # Synopsis: Generate ./Release structure -task GenerateRelease { +task GenerateRelease CreateHelp, { # Setup if (-not (Test-Path "$releasePath/$ModuleName")) { $null = New-Item -Path "$releasePath/$ModuleName" -ItemType Directory @@ -139,6 +139,16 @@ task GenerateRelease { BuildHelpers\Update-Metadata -Path "$releasePath/PSScriptAnalyzerSettings.psd1" -PropertyName ExcludeRules -Value '' } +# Synopsis: Use PlatyPS to generate External-Help +task CreateHelp -If (Get-ChildItem "$BuildRoot/docs/en-US/commands" -ErrorAction SilentlyContinue) { + Import-Module platyPS -Force + foreach ($locale in (Get-ChildItem "$BuildRoot/docs" -Attribute Directory)) { + New-ExternalHelp -Path "$($locale.FullName)" -OutputPath "$BuildRoot/$ModuleName/$($locale.Basename)" -Force + New-ExternalHelp -Path "$($locale.FullName)/commands" -OutputPath "$BuildRoot/$ModuleName/$($locale.Basename)" -Force + } + Remove-Module $ModuleName, platyPS +} + # Synopsis: Update the manifest of the module task UpdateManifest GetVersion, { Remove-Module $ModuleName -ErrorAction SilentlyContinue @@ -156,6 +166,9 @@ task UpdateManifest GetVersion, { if ($ModuleAlias) { BuildHelpers\Update-Metadata -Path "$releasePath/$ModuleName/$ModuleName.psd1" -PropertyName AliasesToExport -Value @($ModuleAlias.Name) } + else { + BuildHelpers\Update-Metadata -Path "$releasePath/$ModuleName/$ModuleName.psd1" -PropertyName AliasesToExport -Value '' + } BuildHelpers\Set-ModuleFunctions -Name "$releasePath/$ModuleName/$ModuleName.psd1" -FunctionsToExport ([string[]](Get-ChildItem "$releasePath/$ModuleName/public/*.ps1").BaseName) } From debc11ece7bd8bbc1fc806fd1675732b68617ee4 Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Thu, 19 Apr 2018 22:33:19 +0200 Subject: [PATCH 7/7] Updated link in ReadMe --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 87d9b5de..68c2dda1 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ Hopefully this is obvious, but: [Latest Release]: https://github.com/AtlassianPS/JiraPS/releases/latest [Submit an Issue]: https://github.com/AtlassianPS/JiraPS/issues/new [replicaJunction]: https://github.com/replicaJunction - [MIT license]: https://github.com/brianbunke/JiraPS/blob/master/LICENSE + [MIT license]: https://github.com/AtlassianPS/JiraPS/blob/master/LICENSE [Contributing]: http://atlassianps.org/docs/Contributing