Summary

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

Details

Page properties

Content

...	...	@@ -65,12 +65,135 @@
65	65	/rest/git/switchComit/{id}
66	66
67	67	[GET]
68		-)))|(% style="width:189px" %)switch to a certain version and return the history of all commits.|(% style="width:383px" %)(((
	68	+)))|(% style="width:189px" %)(((
	69	+switch to a certain version and return the history of all commits.
	70	+
	71	+**__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
	72	+
	73	+.../archive/git-{timestamp}
	74	+)))|(% style="width:383px" %)(((
69	69	the {id} in the URL should be replaced by the id of the wanted commit.
70	70
71	71	eg :
72	72
73	73	rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
74		-)))|(% style="width:449px" %)
75	75
76		-== ==
	81	+
	82	+)))|(% style="width:449px" %)(((
	83	+{{code language="JSON"}}
	84	+{
	85	+ "timestamp": 1620217014704,
	86	+ "status": "200",
	87	+ "data": [
	88	+ {
	89	+ "date": "Tue May 04 16:37:49 GMT+01:00 2021",
	90	+ "current": "false",
	91	+ "author": "person1232",
	92	+ "id": "11e8707eb50e25c00a62e4efedb5f6071ec7e27e",
	93	+ "message": "version 2"
	94	+ },
	95	+ {
	96	+ "date": "Tue May 04 13:28:12 GMT+01:00 2021",
	97	+ "current": "true",
	98	+ "author": "person1",
	99	+ "id": "4b64d02451f47d9cb91d08faa986c941deef0f5c",
	100	+ "message": "version 1"
	101	+ }
	102	+ ]
	103	+}
	104	+{{/code}}
	105	+)))
	106	+|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:189px" %)(((
	107	+Integrates and pulls changes from a remote repository into the current branch.
	108	+)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
	109	+it returns a success message.
	110	+
	111	+eg :
	112	+
	113	+{{code language="JSON"}}
	114	+{
	115	+ "timestamp": 1620219625637,
	116	+ "status": "200",
	117	+ "data": "branch is now updated"
	118	+}
	119	+{{/code}}
	120	+)))
	121	+|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:189px" %)(((
	122	+Clone a git repository into the directory of the current environment,
	123	+
	124	+if it doesn't exist it creates a new directory and initialize the repo,
	125	+
	126	+if the directory exists, the endpoint rename the directory with and create a new one and clone 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": "ok"
	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	+
	183	+= Errors =
	184	+
	185	+below, you can find an example of technical and functional errors :
	186	+
	187	+{{code language="JSON"}}
	188	+{
	189	+ "timestamp": 1620221672951,
	190	+ "status": "500",
	191	+ "error": "JSON file is not valid",
	192	+ "thechnicalError": "JSONObject[\"fileName\"] not found."
	193	+}
	194	+{{/code}}
	195	+
	196	+the functional error is shown with the JSON key "error", while technical error is stored in the "thechnicalError" key.
	197	+
	198	+
	199	+== ==