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

API needs to change to return a flattened out pipeline list with paths

    Details

    • Similar Issues:
    • Epic Link:
    • Sprint:
      1.0-japan-m9

      Description

      In Scope

      • API needs to change to return a flattened out list with paths at the top level only
      • Subfolders should return only their contents (as they do now)
      • An option should be allowed to specify that non flattened list is required (but is not the default)
      • Should not result in recursing through folders, or load all jobs into memory
      • Objects returns should have links/paths that include the folderName/pipelines/subfolderName/pipelines/PipelineName style of naming so the URI can be set and the data loaded

        Attachments

          Issue Links

            Activity

            Hide
            vivek Vivek Pandey added a comment -

            James Dumay[~mneale]
            >An option should be allowed to specify that non flattened list is required (but is not the default)

            From the API perspective, it will be more consistent to return non-flattened list by default and returned flattened list via query parameter. Its can also can be expensive call so better serve it with parameter.

            >Should not result in recursing through folders, or load all jobs into memory

            Any collection call is expensive, client should use pagination to limit how many items are returned in per call.

            Show
            vivek Vivek Pandey added a comment - James Dumay [~mneale] >An option should be allowed to specify that non flattened list is required (but is not the default) From the API perspective, it will be more consistent to return non-flattened list by default and returned flattened list via query parameter. Its can also can be expensive call so better serve it with parameter. >Should not result in recursing through folders, or load all jobs into memory Any collection call is expensive, client should use pagination to limit how many items are returned in per call.
            Hide
            michaelneale Michael Neale added a comment - - edited

            [~vpandey] ok making it an option is ok for consistency.
            On performance, I mean that pagination should not require that the whole set is loaded into memory.

            Show
            michaelneale Michael Neale added a comment - - edited [~vpandey] ok making it an option is ok for consistency. On performance, I mean that pagination should not require that the whole set is loaded into memory.
            Hide
            michaelneale Michael Neale added a comment -

            Vivek Pandey so this is closed - but not sure what we have to do to get a flattened list back out. Could you add an example to the rest api docs? (or is it default behavior?)

            Show
            michaelneale Michael Neale added a comment - Vivek Pandey so this is closed - but not sure what we have to do to get a flattened list back out. Could you add an example to the rest api docs? (or is it default behavior?)
            Hide
            michaelneale Michael Neale added a comment -

            Just need to clarify some things.

            Show
            michaelneale Michael Neale added a comment - Just need to clarify some things.

              People

              • Assignee:
                vivek Vivek Pandey
                Reporter:
                jamesdumay James Dumay
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: