Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-35795

API(s) for acknowledging request for user input in a pipeline

    • pacific, atlantic, 1.0-b05/b-06, indian, arctic, tasman, christmas

      A pipeline can pause and ask for user input at any point.

      This needs to be exposed via the blue ocean REST api - both that it is waiting, but also that it can take a POST of data to acknowledge it. The input may take the form of Yes/No or it may be a richer set of input.

      In Scope:

      • API to fetch any pipelines blocked on "input" (for current user)
      • API to fetch what input is required from user (so a form can be built up on the client)
      • API to post confirmation from user (binary yes/no)
      • API to take a post of data from user (for non yes/no)
        (these are not necessarily separate unrelated apis, just that there needs to be support for those types of features)

      Out of scope:
      (perhaps we should start with simple yes/no)

          [JENKINS-35795] API(s) for acknowledging request for user input in a pipeline

          James Dumay created issue -
          Michael Neale made changes -
          Epic Link New: UX-165 [ 25873 ]
          Michael Neale made changes -
          Link New: This issue blocks UX-390 [ UX-390 ]

          Michael Neale added a comment -

          See https://cloudbees.atlassian.net/browse/UX-390
          I am not sure if there is a spec for the type of input that pipeline can support. I use the snippet builder to see what options there are (try it).

          The current stage view in Jenkins 2.0 only supports yes/no, but I think we need to support a bit more (not sure how this affects the API though, maybe not at all as it can just pass though).

          Michael Neale added a comment - See https://cloudbees.atlassian.net/browse/UX-390 I am not sure if there is a spec for the type of input that pipeline can support. I use the snippet builder to see what options there are (try it). The current stage view in Jenkins 2.0 only supports yes/no, but I think we need to support a bit more (not sure how this affects the API though, maybe not at all as it can just pass though).
          James Dumay made changes -
          Labels New: api
          James Dumay made changes -
          Rank New: Ranked higher
          James Dumay made changes -
          Rank New: Ranked lower
          Michael Neale made changes -
          Description Original: A pipeline can pause and ask for user input at any point.

          This needs to be exposed somehow via the blue ocean REST api - both that it is waiting, but also that it can take a POST of data to acknowlege it. The input may take the form of Yes/No or it may be a richer set of input.
          New: A pipeline can pause and ask for user input at any point.

          This needs to be exposed via the blue ocean REST api - both that it is waiting, but also that it can take a POST of data to acknowledge it. The input may take the form of Yes/No or it may be a richer set of input.

          In Scope:
             * API to fetch any pipelines blocked on "input" (for current user)
             * API to
          Michael Neale made changes -
          Description Original: A pipeline can pause and ask for user input at any point.

          This needs to be exposed via the blue ocean REST api - both that it is waiting, but also that it can take a POST of data to acknowledge it. The input may take the form of Yes/No or it may be a richer set of input.

          In Scope:
             * API to fetch any pipelines blocked on "input" (for current user)
             * API to
          New: A pipeline can pause and ask for user input at any point.

          This needs to be exposed via the blue ocean REST api - both that it is waiting, but also that it can take a POST of data to acknowledge it. The input may take the form of Yes/No or it may be a richer set of input.

          In Scope:
             * API to fetch any pipelines blocked on "input" (for current user)
             * API to fetch what input is required from user
             * API to post confirmation from user (binary yes/no)
             * API to take a post of data from user (for non yes/no)

          Out of scope:
             (perhaps we should start with simple yes/no)

          Michael Neale added a comment -

          jdumay I think this, and the linked front end ticket, may require some more investigation as to what exactly is required. The current stage viewer can only say "yes/no" to input, pipeline allows more types of input. Do we support them all? A common user request is in the "approval" popover, that pipeline authors could put in some URL/html info (which may depend on context of execution) providing the approver with more context (it's still a yes/no answer, but more info). Thoughts?

          Michael Neale added a comment - jdumay I think this, and the linked front end ticket, may require some more investigation as to what exactly is required. The current stage viewer can only say "yes/no" to input, pipeline allows more types of input. Do we support them all? A common user request is in the "approval" popover, that pipeline authors could put in some URL/html info (which may depend on context of execution) providing the approver with more context (it's still a yes/no answer, but more info). Thoughts?

            vivek Vivek Pandey
            jamesdumay James Dumay
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: