Skip to content

Commit 1b6573a

Browse files
Document REST APIs through OpenAPI specification (jenkinsci#952)
--------- Co-authored-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
1 parent 0e508f9 commit 1b6573a

File tree

2 files changed

+688
-3
lines changed

2 files changed

+688
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ This plugin adds a visual representation of Jenkins pipelines, showing each stag
2222

2323
## Getting started
2424

25-
1. Install the [pipeline-graph-view](https://plugins.jenkins.io/pipeline-graph-view/) plugin
26-
2. Go to a pipeline run (not a job page)
27-
3. Click 'Pipeline Console'
25+
1. Install the [Pipeline Graph View](https://plugins.jenkins.io/pipeline-graph-view/) plugin
26+
2. Go to some pipeline build page (not the job page)
27+
3. Click _Pipeline Overview_
2828

2929
## Screenshots
3030

@@ -42,6 +42,10 @@ See a live demonstration from a Jenkins Contributor Summit:
4242

4343
[![Demo of Pipeline Graph View plugin](https://img.youtube.com/vi/MBI3MBY2eJ8/0.jpg)](https://www.youtube.com/watch?v=MBI3MBY2eJ8&t=3295 "Pipeline Graph View plugin")
4444

45+
## REST API
46+
47+
The REST API documentation can be found [here](https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/jenkinsci/pipeline-graph-view-plugin/refs/heads/main/openapi.yaml).
48+
4549
## Contributing
4650

4751
Refer to our [contribution guidelines](./CONTRIBUTING.md).

0 commit comments

Comments
 (0)