-
Bug
-
Resolution: Won't Do
-
Minor
-
Jenkins 1.617
Workflow 1.8
The REST API isn't available for access to "step" state through the workflow "running steps" page.
e.g. at http://<server>:8080//job/<job name>/<job num>/flowGraphTable/api
I would expect to see a REST API page, indeed there is a link at the bottom of the flowGraphTable page to the REST API page that does not exist.
At the JUC in London Jesse told me that this was probably just a bug, but if you want to make this a feature/improvement request that's fine too 
In general I think it would be massively useful to have access to stateful information for the workflow through the REST API i.e. though XML or JSON. That will allow for better flexibility of use and presentation of the data.
Moreover it would also be nice for groovy workflow script developers to be able to "inject" state such that it can be discoverable through the REST API. e.g. to provide contextual information about a particular step in the workflow. In this sense perhaps it could be linked with JENKINS-26107, or a similar feature that would allow groovy workflow scripts to feedback stateful information to the presentation layer.
Though I suppose this could be fudged in the short term e.g. by saving this data in XML/JSON as artifacts which can be presented through the rest API through the page for the job.
- is related to
-
JENKINS-26522 Annotated block/stage status
-
- Closed
-
[JENKINS-29188] api URL for REST API is not available for flowGraphTable
Thomas Dalton
created issue -
| Description |
Original:
The REST API isn't available for access to "step" state through the workflow "running steps" page. e.g. at http://<server>:8080//job/<job name>/<job num>/flowGraphTable/api I would expect to see a REST API page, indeed there is a link at the bottom of the flowGraphTable page to the REST API page that does not exist. At the JUC in London Jesse told me that this was probably just a bug, but if you want to make this a feature/improvement request that's fine too :) In general I think it would be massively useful to have access to stateful information for the workflow through the REST API i.e. though XML or JSON. That will allow for better flexibility of use and presentation of the data. Moreover it would also be nice for groovy workflow script developers to be able to "inject" state such that it can be discoverable through the REST API. e.g. to provide contextual information about a particular step in the workflow. In this sense perhaps it could be linked with [https://issues.jenkins-ci.org/browse/JENKINS-26107], or a similar feature that would allow groovy workflow scripts to feedback stateful information to the presentation layer. Though I suppose this could be fudged in the short term e.g. by saving this data in XML/JSON as artifacts which can be presented through the rest API through the page for the job. |
New:
The REST API isn't available for access to "step" state through the workflow "running steps" page. e.g. at http://<server>:8080//job/<job name>/<job num>/flowGraphTable/api I would expect to see a REST API page, indeed there is a link at the bottom of the flowGraphTable page to the REST API page that does not exist. At the JUC in London Jesse told me that this was probably just a bug, but if you want to make this a feature/improvement request that's fine too :) In general I think it would be massively useful to have access to stateful information for the workflow through the REST API i.e. though XML or JSON. That will allow for better flexibility of use and presentation of the data. Moreover it would also be nice for groovy workflow script developers to be able to "inject" state such that it can be discoverable through the REST API. e.g. to provide contextual information about a particular step in the workflow. In this sense perhaps it could be linked with Though I suppose this could be fudged in the short term e.g. by saving this data in XML/JSON as artifacts which can be presented through the rest API through the page for the job. |
Thomas Dalton
added a comment - Yes these are effectively 2 things/requests:
- For #1 yes exposing API of the flow graph and all information it contains (console log snippets etc) would be what we're after.
- For #2 this is a request for more, customizable, state to be reflected through the API. So that in your workflow you can expose state for the steps and augment the flow graph with more information.
I see that work has started on a "step-api" which is pleasing to see, perhaps these 2 things can be considered here?
Thomas Dalton
added a comment - Yes these are effectively 2 things/requests:
For #1 yes exposing API of the flow graph and all information it contains (console log snippets etc) would be what we're after.
For #2 this is a request for more, customizable, state to be reflected through the API. So that in your workflow you can expose state for the steps and augment the flow graph with more information.
I see that work has started on a "step-api" which is pleasing to see, perhaps these 2 things can be considered here? Treating this issue for concreteness as the first request. The second is not well defined but sounds similar to JENKINS-26522.
| Link |
New:
This issue is related to |
+1 on this one
It would enable all sorts of User Interfaces to evolve from the data
Any plans on the first requirement here?
- Exposing an Api for what is already defined in the flow graph, or fixing some broken link perhaps.
John Long
added a comment - I was really surprised that this was not implemented.
This lack will make it very hard to integrate into some of our reporting systems and probably will delay our adoption of the Pipelines. It's a shame, I really like them.
John Long
added a comment - I was really surprised that this was not implemented.
This lack will make it very hard to integrate into some of our reporting systems and probably will delay our adoption of the Pipelines. It's a shame, I really like them. | Workflow | Original: JNJira [ 164056 ] | New: JNJira + In-Review [ 181491 ] |
Seems like this is a mixture of two unrelated things: