From 5953650ea2f34f4e1f3794191a1f33a5f8117ad3 Mon Sep 17 00:00:00 2001
From: sumathi-thirumani <57740789+sumathi-thirumani@users.noreply.github.com>
Date: Mon, 27 Jan 2025 08:35:11 -0800
Subject: [PATCH] bruno documentation (#571)

---
 .../bruno/EDUC-GRAD-ALGORITHM-API/bruno.json  |  9 ++++++++
 .../EDUC-GRAD-ALGORITHM-API/collection.bru    | 21 ++++++++++++++++++
 .../environments/dev.bru                      |  8 +++++++
 .../environments/local.bru                    |  8 +++++++
 .../environments/prod.bru                     |  8 +++++++
 .../environments/test.bru                     |  8 +++++++
 .../graduateStudent.bru                       | 22 +++++++++++++++++++
 7 files changed, 84 insertions(+)
 create mode 100644 tools/bruno/EDUC-GRAD-ALGORITHM-API/bruno.json
 create mode 100644 tools/bruno/EDUC-GRAD-ALGORITHM-API/collection.bru
 create mode 100644 tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/dev.bru
 create mode 100644 tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/local.bru
 create mode 100644 tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/prod.bru
 create mode 100644 tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/test.bru
 create mode 100644 tools/bruno/EDUC-GRAD-ALGORITHM-API/grad-algorithm-controller/graduateStudent.bru

diff --git a/tools/bruno/EDUC-GRAD-ALGORITHM-API/bruno.json b/tools/bruno/EDUC-GRAD-ALGORITHM-API/bruno.json
new file mode 100644
index 0000000..af46caf
--- /dev/null
+++ b/tools/bruno/EDUC-GRAD-ALGORITHM-API/bruno.json
@@ -0,0 +1,9 @@
+{
+  "version": "1",
+  "name": "EDUC-GRAD-ALGORITHM-API",
+  "type": "collection",
+  "ignore": [
+    "node_modules",
+    ".git"
+  ]
+}
\ No newline at end of file
diff --git a/tools/bruno/EDUC-GRAD-ALGORITHM-API/collection.bru b/tools/bruno/EDUC-GRAD-ALGORITHM-API/collection.bru
new file mode 100644
index 0000000..8831ef0
--- /dev/null
+++ b/tools/bruno/EDUC-GRAD-ALGORITHM-API/collection.bru
@@ -0,0 +1,21 @@
+headers {
+  Authorization: Bearer {{token}}
+}
+
+auth {
+  mode: oauth2
+}
+
+auth:oauth2 {
+  grant_type: client_credentials
+  access_token_url: {{tokenRootUrl}}/auth/realms/master/protocol/openid-connect/token
+  client_id: {{clientId}}
+  client_secret: {{secret}}
+  scope: 
+}
+
+script:post-response {
+  if(req.getAuthMode() == 'oauth2' && res.body.access_token) {
+      bru.setVar('token', res.body.access_token);
+  }
+}
diff --git a/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/dev.bru b/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/dev.bru
new file mode 100644
index 0000000..0539abf
--- /dev/null
+++ b/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/dev.bru
@@ -0,0 +1,8 @@
+vars {
+  baseUrl: https://educ-grad-algorithm-api-e8a97a-dev.apps.silver.devops.gov.bc.ca
+  tokenRootUrl: https://soam-dev.apps.silver.devops.gov.bc.ca
+}
+vars:secret [
+  clientId,
+  secret
+]
diff --git a/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/local.bru b/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/local.bru
new file mode 100644
index 0000000..e826ddc
--- /dev/null
+++ b/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/local.bru
@@ -0,0 +1,8 @@
+vars {
+  baseUrl: http://localhost:8081
+  tokenRootUrl: https://soam-dev.apps.silver.devops.gov.bc.ca
+}
+vars:secret [
+  clientId,
+  secret
+]
diff --git a/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/prod.bru b/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/prod.bru
new file mode 100644
index 0000000..1cfe664
--- /dev/null
+++ b/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/prod.bru
@@ -0,0 +1,8 @@
+vars {
+  baseUrl: http://localhost:8888
+  tokenRootUrl: https://soam-prod.apps.silver.devops.gov.bc.ca
+}
+vars:secret [
+  clientId,
+  secret
+]
diff --git a/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/test.bru b/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/test.bru
new file mode 100644
index 0000000..18a1bd1
--- /dev/null
+++ b/tools/bruno/EDUC-GRAD-ALGORITHM-API/environments/test.bru
@@ -0,0 +1,8 @@
+vars {
+  baseUrl: http://localhost:8888
+  tokenRootUrl: https://soam-test.apps.silver.devops.gov.bc.ca
+}
+vars:secret [
+  clientId,
+  secret
+]
diff --git a/tools/bruno/EDUC-GRAD-ALGORITHM-API/grad-algorithm-controller/graduateStudent.bru b/tools/bruno/EDUC-GRAD-ALGORITHM-API/grad-algorithm-controller/graduateStudent.bru
new file mode 100644
index 0000000..d9ad420
--- /dev/null
+++ b/tools/bruno/EDUC-GRAD-ALGORITHM-API/grad-algorithm-controller/graduateStudent.bru
@@ -0,0 +1,22 @@
+meta {
+  name: graduateStudent
+  type: http
+  seq: 1
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduatestudent
+  body: none
+  auth: none
+}
+
+params:query {
+  studentID: 
+  gradProgram: 
+  ~projected: 
+  ~hypotheticalGradYear: 
+}
+
+headers {
+  Authorization: 
+}