Skip to content

Commit a7e78b2

Browse files
starter project documentation addded to rest api doc
Signed-off-by: Michael Valdron <[email protected]>
1 parent 436d47d commit a7e78b2

File tree

1 file changed

+96
-1
lines changed

1 file changed

+96
-1
lines changed

index/server/registry-REST-API.adoc

Lines changed: 96 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1990,4 +1990,99 @@ commands:
19901990
group:
19911991
kind: test
19921992
isDefault: true
1993-
----
1993+
----
1994+
1995+
== Download Starter Project from requested Devfile
1996+
1997+
Fetches starter project specified in requested registry stack devfile with version's content and provides an archive (zip) file download as the HTTP response.
1998+
1999+
Note: Only provides download as the response, not the devfile content.
2000+
2001+
=== HTTP Request
2002+
[source]
2003+
----
2004+
GET http://{registry host}/devfiles/{stack}/starterProjects/{starterProject}
2005+
----
2006+
2007+
=== Request Parameters
2008+
2009+
[cols="1,1"]
2010+
|===
2011+
|Parameter|Description
2012+
2013+
|Registry host
2014+
|The URL/ingress that exposes registry service
2015+
2016+
|Stack
2017+
|Registry stack name
2018+
2019+
|Starter Project
2020+
|Starter project name in the stack devfile
2021+
2022+
|===
2023+
2024+
=== Request body
2025+
The request body must be empty.
2026+
2027+
=== Request example
2028+
[source]
2029+
----
2030+
curl http://devfile-registry.192.168.1.1.nip.io/devfiles/nodejs/starterProjects/nodejs-starter -o nodejs-starter.zip
2031+
----
2032+
2033+
=== Response example
2034+
[source]
2035+
----
2036+
% Total % Received % Xferd Average Speed Time Time Time Current
2037+
Dload Upload Total Spent Left Speed
2038+
100 14383 0 14383 0 0 13910 0 --:--:-- 0:00:01 --:--:-- 13910
2039+
----
2040+
2041+
== Download Starter Project from requested Devfile with Version
2042+
2043+
Fetches starter project specified in requested registry stack devfile's content and provides an archive (zip) file download as the HTTP response.
2044+
2045+
Note: Only provides download as the response, not the devfile content.
2046+
2047+
=== HTTP Request
2048+
[source]
2049+
----
2050+
GET http://{registry host}/devfiles/{stack}/{version}/starterProjects/{starterProject}
2051+
----
2052+
2053+
=== Request Parameters
2054+
2055+
[cols="1,1"]
2056+
|===
2057+
|Parameter|Description
2058+
2059+
|Registry host
2060+
|The URL/ingress that exposes registry service
2061+
2062+
|Stack
2063+
|Registry stack name
2064+
2065+
|Version
2066+
|Specific version of the stack, or `latest`
2067+
2068+
|Starter Project
2069+
|Starter project name in the stack devfile
2070+
2071+
|===
2072+
2073+
=== Request body
2074+
The request body must be empty.
2075+
2076+
=== Request example
2077+
[source]
2078+
----
2079+
curl http://devfile-registry.192.168.1.1.nip.io/devfiles/nodejs/1.0.1/starterProjects/nodejs-starter -o nodejs-starter.zip
2080+
----
2081+
2082+
=== Response example
2083+
[source]
2084+
----
2085+
% Total % Received % Xferd Average Speed Time Time Time Current
2086+
Dload Upload Total Spent Left Speed
2087+
100 14383 0 14383 0 0 13910 0 --:--:-- 0:00:01 --:--:-- 13910
2088+
----

0 commit comments

Comments
 (0)