From 16754f2470bb6ba9c7cbb7009884e4a20e2242d3 Mon Sep 17 00:00:00 2001 From: Palak Bhojani Date: Wed, 20 Feb 2019 14:55:59 -0800 Subject: [PATCH] Create documentation for updating api client and updating swagger --- docs/UpdatingAPICLient.md | 15 +++++++++++++++ docs/UpdatingSwagger.md | 17 +++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docs/UpdatingAPICLient.md create mode 100644 docs/UpdatingSwagger.md diff --git a/docs/UpdatingAPICLient.md b/docs/UpdatingAPICLient.md new file mode 100644 index 0000000000..7c63e94e6c --- /dev/null +++ b/docs/UpdatingAPICLient.md @@ -0,0 +1,15 @@ +## Updating the API Client + + +* Clone influxdata/influxdb2-js repo, if you haven’t + * cd influxdata/influxdb2-js + * git pull on master + * git checkout -b “branch name” + * open the repo in vs code + * update the wrapper class with correct api call and return value + * run ‘npm run build && npm run lint’ in the influxdb2-js dir + * git add the changed files + * send a pr for the update to brandon? + * git pull master on influxdb repo + * update the package.json with correct version number + * restart npm \ No newline at end of file diff --git a/docs/UpdatingSwagger.md b/docs/UpdatingSwagger.md new file mode 100644 index 0000000000..270d198ced --- /dev/null +++ b/docs/UpdatingSwagger.md @@ -0,0 +1,17 @@ +## Updating the Swagger.yml + +* get latest from master +* create a separate branch +* update swagger.yml with your change +* once the change is merged in master, cd into influxdb2-js dir +* get latest from master and create a separate branch +* run ‘npm run generate’ command in influxdb2-js dir +* npm run buid && npm run lint +* git status +* git add . +* git commit -m “message” +* git push +* create pr and merge it in +* get latest from master +* create a separate branch +* update influxdb2-js in package.json with correct version