Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit 5042c7e

Browse files
authored
Added docs for REST API Version to SCDF Version (#5086)
Add brief discussion on RESTFul API Version * Where to find it * Maps between the REST API version and SCDF Version
1 parent 553d850 commit 5042c7e

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

spring-cloud-dataflow-docs/src/main/asciidoc/api-guide.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,39 @@ In fact, the Spring Cloud Data Flow shell is a first-class consumer of that API.
1515
TIP: If you plan to use the REST API with Java, you should consider using the
1616
provided Java client (`DataflowTemplate`) that uses the REST API internally.
1717

18+
[[api-guide-version]]
19+
=== HTTP Version
1820

21+
Spring Cloud Data Flow establishes a RESTful API version that is updated when there is a breaking change to the API.
22+
The API version can be seen at the end of the home page of Spring Cloud Data Flow as shown in the example below:
23+
24+
====
25+
[source,json]
26+
----
27+
{"_links":
28+
{"dashboard":{"href":"http://localhost:9393/dashboard"}
29+
...
30+
},
31+
"api.revision":14}
32+
----
33+
====
34+
The table below shows the SCDF Release version and its current RESTful API version.
35+
36+
|===
37+
| SCDF Version | API Version
38+
39+
| 2.10.x
40+
| 14
41+
42+
| 2.9.x
43+
| 14
44+
45+
| 2.8.x
46+
| 14
47+
48+
| 2.7.x
49+
| 14
50+
|===
1951

2052
[[api-guide-overview-http-verbs]]
2153
=== HTTP verbs

0 commit comments

Comments
 (0)