bruno documentation (#580)

tools/bruno/EDUC-GRAD-GRADUATION-API/EDW Snapshot/Run a Graduation snapshot for EDW.bru

@@ -0,0 +1,26 @@
+meta {
+  name: Run a Graduation snapshot for EDW
+  type: http
+  seq: 1
+}
+
+post {
+  url: {{baseUrl}}/api/v1/graduate/edw/snapshot
+  body: json
+  auth: none
+}
+
+body:json {
+  {
+    "studentID": "",
+    "gradYear": "",
+    "pen": "",
+    "graduationFlag": "",
+    "honoursStanding": "",
+    "gpa": "",
+    "graduatedDate": "",
+    "runDate": "",
+    "sessionDate": "",
+    "schoolOfRecord": ""
+  }
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Graduation Data/Adapt graduation data for reporting.bru

@@ -0,0 +1,15 @@
+meta {
+  name: Adapt graduation data for reporting
+  type: http
+  seq: 1
+}
+
+post {
+  url: {{baseUrl}}/api/v1/graduate/report/data
+  body: json
+  auth: none
+}
+
+params:query {
+  ~type: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Graduation Data/Get Report data from graduation by student pen.bru

@@ -0,0 +1,19 @@
+meta {
+  name: Get Report data from graduation by student pen
+  type: http
+  seq: 3
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/data/:pen
+  body: none
+  auth: none
+}
+
+params:query {
+  ~type: 
+}
+
+params:path {
+  pen: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Graduation Data/Get Transcript binary from graduation by student pen.bru

@@ -0,0 +1,20 @@
+meta {
+  name: Get Transcript binary from graduation by student pen
+  type: http
+  seq: 2
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/transcript/:pen
+  body: none
+  auth: none
+}
+
+params:query {
+  ~interim: 
+  ~preview: 
+}
+
+params:path {
+  pen: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Graduation/Run different Grad Runs and Graduate Student by Student ID and projected type.bru

@@ -0,0 +1,20 @@
+meta {
+  name: Run different Grad Runs and Graduate Student by Student ID and projected type
+  type: http
+  seq: 1
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/studentid/:studentID/run/:projectedType
+  body: none
+  auth: none
+}
+
+params:query {
+  ~batchId: 
+}
+
+params:path {
+  studentID: 
+  projectedType: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/District Report Creation.bru

@@ -0,0 +1,15 @@
+meta {
+  name: District Report Creation
+  type: http
+  seq: 25
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/districtmonth
+  body: none
+  auth: none
+}
+
+headers {
+  Authorization: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/District Report Generation -PDF-.bru

@@ -0,0 +1,15 @@
+meta {
+  name: District Report Generation -PDF-
+  type: http
+  seq: 24
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/districtmonthpdf
+  body: none
+  auth: none
+}
+
+headers {
+  Authorization: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/School - District Report Creation.bru

@@ -0,0 +1,21 @@
+meta {
+  name: School - District Report Creation
+  type: http
+  seq: 19
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/schooldistrictmonth
+  body: none
+  auth: none
+}
+
+params:query {
+  ~slrt: 
+  ~drt: 
+  ~srt: 
+}
+
+headers {
+  Authorization: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/School - District Report Retrieval.bru

@@ -0,0 +1,21 @@
+meta {
+  name: School - District Report Retrieval
+  type: http
+  seq: 18
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/schooldistrictmonthpdf
+  body: none
+  auth: none
+}
+
+params:query {
+  ~slrt: 
+  ~drt: 
+  ~srt: 
+}
+
+headers {
+  Authorization: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/School Labels Report Creation.bru

@@ -0,0 +1,25 @@
+meta {
+  name: School Labels Report Creation
+  type: http
+  seq: 9
+}
+
+post {
+  url: {{baseUrl}}/api/v1/graduate/report/school/labels/pdf
+  body: json
+  auth: none
+}
+
+params:query {
+  reportType: 
+}
+
+headers {
+  Authorization: 
+}
+
+body:json {
+  [
+    {}
+  ]
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/School Report Creation.bru

@@ -0,0 +1,25 @@
+meta {
+  name: School Report Creation
+  type: http
+  seq: 5
+}
+
+post {
+  url: {{baseUrl}}/api/v1/graduate/report/school
+  body: json
+  auth: none
+}
+
+params:query {
+  ~type: 
+}
+
+headers {
+  Authorization: 
+}
+
+body:json {
+  [
+    {}
+  ]
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/School Report Generation.bru

@@ -0,0 +1,21 @@
+meta {
+  name: School Report Generation
+  type: http
+  seq: 7
+}
+
+post {
+  url: {{baseUrl}}/api/v1/graduate/report/school/pdf
+  body: json
+  auth: none
+}
+
+params:query {
+  type: 
+}
+
+body:json {
+  [
+    {}
+  ]
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/School Year End Report Creation.bru

@@ -0,0 +1,15 @@
+meta {
+  name: School Year End Report Creation
+  type: http
+  seq: 13
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/schoolmonth
+  body: none
+  auth: none
+}
+
+headers {
+  Authorization: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/School Year End Report Generation -PDF-.bru

@@ -0,0 +1,15 @@
+meta {
+  name: School Year End Report Generation -PDF-
+  type: http
+  seq: 11
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/schoolyearendpdf
+  body: none
+  auth: none
+}
+
+headers {
+  Authorization: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/Student Certificate Creation.bru

@@ -0,0 +1,19 @@
+meta {
+  name: Student Certificate Creation
+  type: http
+  seq: 26
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/certificate/:pen
+  body: none
+  auth: none
+}
+
+params:query {
+  ~isOverwrite: 
+}
+
+params:path {
+  pen: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/Reports/Students for year end reports.bru

@@ -0,0 +1,15 @@
+meta {
+  name: Students for year end reports
+  type: http
+  seq: 10
+}
+
+get {
+  url: {{baseUrl}}/api/v1/graduate/report/studentsforyearend
+  body: none
+  auth: none
+}
+
+headers {
+  Authorization: 
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/bruno.json

@@ -0,0 +1,9 @@
+{
+  "version": "1",
+  "name": "EDUC-GRAD-GRADUATION-API",
+  "type": "collection",
+  "ignore": [
+    "node_modules",
+    ".git"
+  ]
+}

tools/bruno/EDUC-GRAD-GRADUATION-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);
+  }
+}

tools/bruno/EDUC-GRAD-GRADUATION-API/environments/dev.bru

@@ -0,0 +1,8 @@
+vars {
+  baseUrl: https://educ-grad-graduation-api-77c02f-dev.apps.silver.devops.gov.bc.ca
+  tokenRootUrl: https://soam-dev.apps.silver.devops.gov.bc.ca
+}
+vars:secret [
+  clientId,
+  secret
+]

tools/bruno/EDUC-GRAD-GRADUATION-API/environments/local.bru

@@ -0,0 +1,8 @@
+vars {
+  baseUrl: http://localhost:8088
+  tokenRootUrl: https://soam-dev.apps.silver.devops.gov.bc.ca
+}
+vars:secret [
+  clientId,
+  secret
+]

tools/bruno/EDUC-GRAD-GRADUATION-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
+]

tools/bruno/EDUC-GRAD-GRADUATION-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
+]