Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -79,9 +79,7 @@
79	79	rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
80	80
81	81
82		-)))|(% style="width:449px" %)(((
83		-{{code language="JSON"}}
84		-{
	82	+)))|(% style="width:449px" %){{code language="JSON"}}{
85	85	"timestamp": 1620217014704,
86	86	"status": "200",
87	87	"data": [
...	...	@@ -100,9 +100,7 @@
100	100	"message": "version 1"
101	101	}
102	102	]
103		-}
104		-{{/code}}
105		-)))
	101	+}{{/code}}
106	106	|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:189px" %)(((
107	107	Integrates and pulls changes from a remote repository into the current branch.
108	108	)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
...	...	@@ -118,101 +118,6 @@
118	118	}
119	119	{{/code}}
120	120	)))
121		-|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:189px" %)(((
122		-Clone a git repository into the directory of the current environment,
	117	+|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:189px" %) |(% style="width:383px" %) |(% style="width:449px" %)
123	123
124		-if it doesn't exist it creates a new directory and initialize the repo,
125		-
126		-if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
127		-)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
128		-it returns a "success" message :
129		-
130		-eg :
131		-
132		-{{code language="JSON"}}
133		-{
134		- "timestamp": 1620229625932,
135		- "status": "200",
136		- "data": "Repository initialized successfully !"
137		-}
138		-{{/code}}
139		-)))
140		-|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:189px" %)switch to a certain branch|(% style="width:383px" %)(((
141		-the {branch} must be replaced by the name of the branch destination.
142		-
143		-eg : /rest/git/checkout/master
144		-
145		- /rest/git/checkout/develop
146		-)))|(% style="width:449px" %)(((
147		-it returns a "success" message of checkout branch.
148		-
149		-eg :
150		-
151		-{{code language="JSON"}}
152		-{
153		- "timestamp": 1620229625932,
154		- "status": "200",
155		- "data": "switched to branch : master"
156		-}
157		-{{/code}}
158		-)))
159		-|(% style="width:166px" %)(((
160		-/rest/git/newbranch/{branch}
161		-
162		-[POST]
163		-)))|(% style="width:189px" %)create and switch to a new branch |(% style="width:383px" %)(((
164		-the {branch} must be replaced by the name of the branch destination.
165		-
166		-eg :
167		-
168		- /rest/git/checkout/newBranch
169		-)))|(% style="width:449px" %)(((
170		-it returns a "success" message of the branch creation.
171		-
172		-eg :
173		-
174		-{{code language="JSON"}}
175		-{
176		- "timestamp": 1620229625932,
177		- "status": "200",
178		- "data": "new branch has been created : newBranch"
179		-}
180		-{{/code}}
181		-)))
182		-|(% style="width:166px" %)/rest/git/revert [POST]|(% style="width:189px" %)switch the modified file to the initial head version. |(% style="width:383px" %){{code language="JSON"}}{
183		-"files":
184		-[
185		-{"fileName" : "newFile.xml"},
186		-{"fileName" : "/dir/modifiedFile.pdf"}
187		-]
188		-}{{/code}}|(% style="width:449px" %)(((
189		-it returns a "success" message.
190		-
191		-eg :
192		-
193		-{{code language="JSON"}}
194		-{
195		- "timestamp": 1620229625932,
196		- "status": "200",
197		- "data": "the selected files has been synchronized to HEAD successfully !"
198		-}
199		-{{/code}}
200		-)))
201		-
202		-= Errors =
203		-
204		-below, you can find an example of technical and functional errors :
205		-
206		-{{code language="JSON"}}
207		-{
208		- "timestamp": 1620221672951,
209		- "status": "500",
210		- "error": "JSON file is not valid",
211		- "thechnicalError": "JSONObject[\"fileName\"] not found."
212		-}
213		-{{/code}}
214		-
215		-the functional error is shown with the JSON key "error", while technical error is stored in the "thechnicalError" key.
216		-
217		-
218		-== ==
	119	+== ==