Changes for page Tracking Type

Last modified by Achraf El Kari on 2022/06/13 13:17

From version < 1.29 >

edited by Outhman Moustaghfir
on 2021/05/05 15:16

To version < 7.4 >

edited by Achraf El Kari
on 2021/11/23 11:45

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--GIT endpoints
++Tracking Type

Author

@@ -1,1 +1,1 @@
--XWiki.omoustaghfir
++XWiki.aelkari

Content

@@ -4,12 +4,25 @@
  = Introduction =
--Git endpoints take advantage of all git commands known and needed to create versions of files.
++We will go through all endpoints needed to manage the Tracking type entity.
  = Endpoints =
--|(% style="width:166px" %)**URL [method]**|(% style="width:189px" %)**Description**|(% style="width:383px" %)**Input example**|(% style="width:449px" %)**Output example**
--|(% style="width:166px" %)/rest/git/getstatus [GET]|(% style="width:189px" %)get all files that have been modified or untracked|(% style="width:383px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
++**PS :** __//For all those endpoints, the env params is andatory on the header, otherwise you got an error 400 (BAD PARAMS).//__
++
++
++|(% style="width:166px" %)**URL [method]**|(% style="width:238px" %)**Description**|(% style="width:599px" %)**Input example**|(% style="width:449px" %)**Output example**
++|(% style="width:166px" %)(((
++/rest/trackingType [GET]
++
++
++hedear : Authorization + env => Mandatory
++
++)))|(% style="width:238px" %)(((
++get **all **tracking Type of the giving environment ==>
++
++order, orderLine...
++)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
      "timestamp": 1620216790744,
      "status": "200",
      "data": [
@@ -23,7 +23,7 @@
          }
      ]
  }{{/code}}
--|(% style="width:166px" %)/rest/git/history [GET]|(% style="width:189px" %)get all commits history, with their IDs ,authors ,messages, dates and if considired as current version or not |(% style="width:383px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
++|(% style="width:166px" %)/rest/git/history [GET]|(% style="width:238px" %)get all commits history, with their IDs ,authors ,messages, dates and if considired as current version or not |(% style="width:599px" %)(no input required)|(% style="width:449px" %){{code language="JSON"}}{
      "timestamp": 1620217014704,
      "status": "200",
      "data": [
@@ -43,7 +43,7 @@
          }
      ]
  }{{/code}}
--|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:189px" %)commit changes in files with a message|(% style="width:383px" %){{code language="JSON"}}{
++|(% style="width:166px" %)/rest/git/commit [POST]|(% style="width:238px" %)commit changes in files with a message|(% style="width:599px" %){{code language="JSON"}}{
  "files":
  [
  {"fileName" : "newFile.xml"},
@@ -65,13 +65,13 @@
  /rest/git/switchComit/{id}
  [GET]
--)))|(% style="width:189px" %)(((
++)))|(% style="width:238px" %)(((
  switch to a certain version and return the history of all commits.
  **__NB __**: if there are some modified files in the current version, these files will be moved to a new directory called :
  .../archive/git-{timestamp}
--)))|(% style="width:383px" %)(((
++)))|(% style="width:599px" %)(((
  the {id} in the URL should be replaced by the id of the wanted commit.
  eg :
@@ -79,7 +79,9 @@
  rest/git/switchComit/4b64d02451f47d9cb91d08faa986c941deef0f5c
--)))|(% style="width:449px" %){{code language="JSON"}}{
++)))|(% style="width:449px" %)(((
++{{code language="JSON"}}
++{
      "timestamp": 1620217014704,
      "status": "200",
      "data": [
@@ -98,10 +98,12 @@
              "message": "version 1"
          }
      ]
--}{{/code}}
--|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:189px" %)(((
++}
++{{/code}}
++)))
++|(% style="width:166px" %)/rest/git/update [GET]|(% style="width:238px" %)(((
  Integrates and pulls changes from a remote repository into the current branch.
--)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
++)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
  it returns a success message.
  eg :
@@ -114,18 +114,101 @@
  }
  {{/code}}
  )))
--|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:189px" %)(((
++|(% style="width:166px" %)/rest/environment/init [POST]|(% style="width:238px" %)(((
  Clone a git repository into the directory of the current environment,
  if it doesn't exist it creates a new directory and initialize the repo,
--if the directory exists, the endpoint rename the directory with and create a new one and clone the repository.
--)))|(% style="width:383px" %)(no input required)|(% style="width:449px" %)(((
++if the directory exists, the endpoint renames the directory and creates a new one and clones the repository.
++)))|(% style="width:599px" %)(no input required)|(% style="width:449px" %)(((
  it returns a "success" message :
  eg :
--
++{{code language="JSON"}}
++{
++    "timestamp": 1620229625932,
++    "status": "200",
++    "data": "Repository initialized successfully !"
++}
++{{/code}}
  )))
++|(% style="width:166px" %)/rest/git/checkout/{branch} [POST]|(% style="width:238px" %)switch to a certain branch|(% style="width:599px" %)(((
++the {branch} must be replaced by the name of the branch destination.
--==   ==
++eg : /rest/git/checkout/master
++
++    /rest/git/checkout/develop
++)))|(% style="width:449px" %)(((
++it returns a "success" message of checkout branch.
++
++eg :
++
++{{code language="JSON"}}
++{
++    "timestamp": 1620229625932,
++    "status": "200",
++    "data": "switched to branch : master"
++}
++{{/code}}
++)))
++|(% style="width:166px" %)(((
++/rest/git/newbranch/{branch}
++
++[POST]
++)))|(% style="width:238px" %)create and switch to a new branch |(% style="width:599px" %)(((
++the {branch} must be replaced by the name of the branch destination.
++
++eg :
++
++    /rest/git/checkout/newBranch
++)))|(% style="width:449px" %)(((
++it returns a "success" message of the branch creation.
++
++eg :
++
++{{code language="JSON"}}
++{
++    "timestamp": 1620229625932,
++    "status": "200",
++    "data": "new branch has been created : newBranch"
++}
++{{/code}}
++)))
++|(% style="width:166px" %)/rest/git/revert [POST]|(% style="width:238px" %)switch the modified file to the initial head version. |(% style="width:599px" %){{code language="JSON"}}{
++"files":
++[
++{"fileName" : "newFile.xml"},
++{"fileName" : "/dir/modifiedFile.pdf"}
++]
++}{{/code}}|(% style="width:449px" %)(((
++it returns a "success" message.
++
++eg :
++
++{{code language="JSON"}}
++{
++    "timestamp": 1620229625932,
++    "status": "200",
++    "data": "the selected files has been synchronized to HEAD successfully !"
++}
++{{/code}}
++)))
++
++= Errors =
++
++below, you can find an example of technical and functional errors :
++
++{{code language="JSON"}}
++{
++    "timestamp": 1620221672951,
++    "status": "500",
++    "error": "JSON file is not valid",
++    "thechnicalError": "JSONObject[\"fileName\"] not found."
++}
++{{/code}}
++
++the functional error is shown with the JSON key "error", while technical error is stored in the "thechnicalError" key.
++
++
++==  ==

Changes for page Tracking Type

Summary

Details

Navigation

Applications