From 287b18ad3d8305fdc080a605cac8eddcbd95ab0c Mon Sep 17 00:00:00 2001 From: sumathi-thirumani <57740789+sumathi-thirumani@users.noreply.github.com> Date: Mon, 27 Jan 2025 14:04:48 -0800 Subject: [PATCH] bruno documentation (#176) --- ...duation data for certificate reporting.bru | 15 ++++++++++++ ...aduation data for transcript reporting.bru | 19 +++++++++++++++ ...rt data from graduation by student pen.bru | 19 +++++++++++++++ ...graduation by distcode and report type.bru | 19 +++++++++++++++ ... graduation by mincode and report type.bru | 19 +++++++++++++++ ... TVR Report pdf by PEN and report type.bru | 20 ++++++++++++++++ ...rt data from graduation by student pen.bru | 23 ++++++++++++++++++ ...by PEN and optional xml type parameter.bru | 24 +++++++++++++++++++ .../Get Xml Data for transcript reporting.bru | 15 ++++++++++++ .../Get Student Demographic by PEN.bru | 19 +++++++++++++++ .../Get student document by PEN.bru | 20 ++++++++++++++++ .../Search For Students by PEN.bru | 19 +++++++++++++++ tools/bruno/EDUC-GRAD-BUSINESS-API/bruno.json | 9 +++++++ .../EDUC-GRAD-BUSINESS-API/collection.bru | 21 ++++++++++++++++ .../environments/dev.bru | 8 +++++++ .../environments/local.bru | 8 +++++++ .../environments/prod.bru | 8 +++++++ .../environments/test.bru | 8 +++++++ 18 files changed, 293 insertions(+) create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Adapt graduation data for certificate reporting.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Adapt graduation data for transcript reporting.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Certificate Report data from graduation by student pen.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get District Report pdf from graduation by distcode and report type.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get School Report pdf from graduation by mincode and report type.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Student Transcript or TVR Report pdf by PEN and report type.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Transcript Report data from graduation by student pen.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Transcript Report pdf by PEN and optional xml type parameter.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Xml Data for transcript reporting.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Get Student Demographic by PEN.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Get student document by PEN.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Search For Students by PEN.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/bruno.json create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/collection.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/environments/dev.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/environments/local.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/environments/prod.bru create mode 100644 tools/bruno/EDUC-GRAD-BUSINESS-API/environments/test.bru diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Adapt graduation data for certificate reporting.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Adapt graduation data for certificate reporting.bru new file mode 100644 index 0000000..46a635c --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Adapt graduation data for certificate reporting.bru @@ -0,0 +1,15 @@ +meta { + name: Adapt graduation data for certificate reporting + type: http + seq: 3 +} + +post { + url: {{baseUrl}}/api/v1/certificate/report/data + body: json + auth: none +} + +headers { + Authorization: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Adapt graduation data for transcript reporting.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Adapt graduation data for transcript reporting.bru new file mode 100644 index 0000000..4b7756a --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Adapt graduation data for transcript reporting.bru @@ -0,0 +1,19 @@ +meta { + name: Adapt graduation data for transcript reporting + type: http + seq: 2 +} + +post { + url: {{baseUrl}}/api/v1/transcript/report/data + body: json + auth: none +} + +params:query { + ~type: +} + +headers { + Authorization: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Certificate Report data from graduation by student pen.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Certificate Report data from graduation by student pen.bru new file mode 100644 index 0000000..2b72112 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Certificate Report data from graduation by student pen.bru @@ -0,0 +1,19 @@ +meta { + name: Get Certificate Report data from graduation by student pen + type: http + seq: 10 +} + +get { + url: {{baseUrl}}/api/v1/certificate/report/data/:pen + body: none + auth: none +} + +params:path { + pen: +} + +headers { + Authorization: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get District Report pdf from graduation by distcode and report type.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get District Report pdf from graduation by distcode and report type.bru new file mode 100644 index 0000000..c498b17 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get District Report pdf from graduation by distcode and report type.bru @@ -0,0 +1,19 @@ +meta { + name: Get District Report pdf from graduation by distcode and report type + type: http + seq: 5 +} + +get { + url: {{baseUrl}}/api/v2/district/report/:distcode + body: none + auth: none +} + +params:query { + type: +} + +params:path { + distcode: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get School Report pdf from graduation by mincode and report type.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get School Report pdf from graduation by mincode and report type.bru new file mode 100644 index 0000000..79d33e1 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get School Report pdf from graduation by mincode and report type.bru @@ -0,0 +1,19 @@ +meta { + name: Get School Report pdf from graduation by mincode and report type + type: http + seq: 11 +} + +get { + url: {{baseUrl}}/api/v1/amalgamated/schoolreport/:mincode + body: none + auth: none +} + +params:query { + type: +} + +params:path { + mincode: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Student Transcript or TVR Report pdf by PEN and report type.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Student Transcript or TVR Report pdf by PEN and report type.bru new file mode 100644 index 0000000..90c8377 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Student Transcript or TVR Report pdf by PEN and report type.bru @@ -0,0 +1,20 @@ +meta { + name: Get Student Transcript or TVR Report pdf by PEN and report type + type: http + seq: 8 +} + +get { + url: {{baseUrl}}/api/v1/studentcredential/:pen/type/:type + body: none + auth: none +} + +params:path { + pen: + type: +} + +headers { + Authorization: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Transcript Report data from graduation by student pen.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Transcript Report data from graduation by student pen.bru new file mode 100644 index 0000000..296a6e4 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Transcript Report data from graduation by student pen.bru @@ -0,0 +1,23 @@ +meta { + name: Get Transcript Report data from graduation by student pen + type: http + seq: 6 +} + +get { + url: {{baseUrl}}/api/v1/transcript/report/data/:pen + body: none + auth: none +} + +params:query { + ~type: +} + +params:path { + pen: +} + +headers { + Authorization: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Transcript Report pdf by PEN and optional xml type parameter.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Transcript Report pdf by PEN and optional xml type parameter.bru new file mode 100644 index 0000000..5661769 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Transcript Report pdf by PEN and optional xml type parameter.bru @@ -0,0 +1,24 @@ +meta { + name: Get Transcript Report pdf by PEN and optional xml type parameter + type: http + seq: 7 +} + +get { + url: {{baseUrl}}/api/v1/studenttranscript/:pen + body: none + auth: none +} + +params:query { + ~type: + ~interim: +} + +params:path { + pen: +} + +headers { + Authorization: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Xml Data for transcript reporting.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Xml Data for transcript reporting.bru new file mode 100644 index 0000000..728447e --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Graduation Data/Get Xml Data for transcript reporting.bru @@ -0,0 +1,15 @@ +meta { + name: Get Xml Data for transcript reporting + type: http + seq: 1 +} + +post { + url: {{baseUrl}}/api/v1/transcript/xml/report/data + body: json + auth: none +} + +headers { + Authorization: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Get Student Demographic by PEN.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Get Student Demographic by PEN.bru new file mode 100644 index 0000000..0ae896e --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Get Student Demographic by PEN.bru @@ -0,0 +1,19 @@ +meta { + name: Get Student Demographic by PEN + type: http + seq: 1 +} + +get { + url: {{baseUrl}}/api/v1/student/demog/:pen + body: none + auth: none +} + +params:path { + pen: +} + +headers { + Authorization: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Get student document by PEN.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Get student document by PEN.bru new file mode 100644 index 0000000..098d8e5 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Get student document by PEN.bru @@ -0,0 +1,20 @@ +meta { + name: Get student document by PEN + type: http + seq: 3 +} + +get { + url: {{baseUrl}}/api/v1/document/:pen + body: none + auth: none +} + +params:query { + ~docType: + ~docFormat: +} + +params:path { + pen: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Search For Students by PEN.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Search For Students by PEN.bru new file mode 100644 index 0000000..c8e80b7 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/Student Demographics/Search For Students by PEN.bru @@ -0,0 +1,19 @@ +meta { + name: Search For Students by PEN + type: http + seq: 2 +} + +get { + url: {{baseUrl}}/api/v1/pen/:pen + body: none + auth: none +} + +params:path { + pen: +} + +headers { + Authorization: +} diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/bruno.json b/tools/bruno/EDUC-GRAD-BUSINESS-API/bruno.json new file mode 100644 index 0000000..655eccd --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/bruno.json @@ -0,0 +1,9 @@ +{ + "version": "1", + "name": "EDUC-GRAD-BUSINESS-API", + "type": "collection", + "ignore": [ + "node_modules", + ".git" + ] +} \ No newline at end of file diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/collection.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/collection.bru new file mode 100644 index 0000000..8831ef0 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-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-BUSINESS-API/environments/dev.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/environments/dev.bru new file mode 100644 index 0000000..7032280 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/environments/dev.bru @@ -0,0 +1,8 @@ +vars { + baseUrl: https://educ-grad-business-api-77c02f-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-BUSINESS-API/environments/local.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/environments/local.bru new file mode 100644 index 0000000..55b5ead --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-API/environments/local.bru @@ -0,0 +1,8 @@ +vars { + baseUrl: http://localhost:8084 + tokenRootUrl: https://soam-dev.apps.silver.devops.gov.bc.ca +} +vars:secret [ + clientId, + secret +] diff --git a/tools/bruno/EDUC-GRAD-BUSINESS-API/environments/prod.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/environments/prod.bru new file mode 100644 index 0000000..1cfe664 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-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-BUSINESS-API/environments/test.bru b/tools/bruno/EDUC-GRAD-BUSINESS-API/environments/test.bru new file mode 100644 index 0000000..18a1bd1 --- /dev/null +++ b/tools/bruno/EDUC-GRAD-BUSINESS-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 +]