Skip to content

Commit

Permalink
bruno documentation (#340)
Browse files Browse the repository at this point in the history
  • Loading branch information
sumathi-thirumani authored Jan 27, 2025
1 parent a02a766 commit ac2ddd7
Show file tree
Hide file tree
Showing 22 changed files with 275 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
meta {
name: Read All Data required by Grad Algorithm
type: http
seq: 2
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/algo/algorithmdata/:programCode
body: none
auth: none
}

params:path {
programCode:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
meta {
name: Read All Grad Algorithm Rules by Program Code
type: http
seq: 4
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/algo/algorithm-rules/:programCode
body: none
auth: none
}

params:path {
programCode:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Read All Grad Algorithm Rules
type: http
seq: 3
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/algo/algorithm-rules
body: none
auth: none
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
meta {
name: Find a Grad Messaging
type: http
seq: 2
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/transcript/gradmessages/pgmCode/:pgmCode/msgType/:msgType
body: none
auth: none
}

params:path {
pgmCode:
msgType:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Find all Grad Messaging
type: http
seq: 1
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/transcript/gradmessages
body: none
auth: none
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Find All Letter Grade
type: http
seq: 3
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/lgSc/lettergrade
body: none
auth: none
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Find All Special Cases
type: http
seq: 1
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/lgSc/specialcase
body: none
auth: none
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
meta {
name: Find a Specific Letter Grade
type: http
seq: 4
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/lgSc/lettergrade/:letterGrade
body: none
auth: none
}

params:path {
letterGrade:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
meta {
name: Find a Specific Special Case
type: http
seq: 2
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/lgSc/specialcase/:specialCode
body: none
auth: none
}

params:path {
specialCode:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Create an Ungrad Reason
type: http
seq: 3
}

post {
url: {{baseUrl}}/api/v1/studentgraduation/undocompletion/undocompletionreason
body: json
auth: none
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
meta {
name: Create an Ungrad Reasons
type: http
seq: 5
}

post {
url: {{baseUrl}}/api/v1/studentgraduation/undocompletion/studentundocompletionreason/studentid/:studentID
body: json
auth: none
}

params:path {
studentID:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
meta {
name: Delete an Ungrad Reason
type: http
seq: 7
}

delete {
url: {{baseUrl}}/api/v1/studentgraduation/undocompletion/undocompletionreason/:reasonCode
body: none
auth: none
}

params:path {
reasonCode:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
meta {
name: Find Student Ungrad Reasons by Student ID
type: http
seq: 4
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/undocompletion/studentundocompletionreason/studentid/:studentID
body: none
auth: none
}

params:path {
studentID:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Find all Ungrad Reasons
type: http
seq: 1
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/undocompletion/undocompletionreason
body: none
auth: none
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
meta {
name: Find an Ungrad Reason by Ungrad Reasons Code
type: http
seq: 6
}

get {
url: {{baseUrl}}/api/v1/studentgraduation/undocompletion/undocompletionreason/:reasonCode
body: none
auth: none
}

params:path {
reasonCode:
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
meta {
name: Update an Ungrad Reason
type: http
seq: 2
}

put {
url: {{baseUrl}}/api/v1/studentgraduation/undocompletion/undocompletionreason
body: json
auth: none
}
9 changes: 9 additions & 0 deletions tools/bruno/EDUC-GRAD-STUDENT-GRADUATION-API/bruno.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"version": "1",
"name": "EDUC-GRAD-STUDENT-GRADUATION-API",
"type": "collection",
"ignore": [
"node_modules",
".git"
]
}
21 changes: 21 additions & 0 deletions tools/bruno/EDUC-GRAD-STUDENT-GRADUATION-API/collection.bru
Original file line number Diff line number Diff line change
@@ -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);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
vars {
baseUrl: https://educ-grad-student-graduation-api-77c02f-dev.apps.silver.devops.gov.bc.ca
tokenRootUrl: https://soam-dev.apps.silver.devops.gov.bc.ca
}
vars:secret [
clientId,
secret
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
vars {
baseUrl: http://localhost:8093
tokenRootUrl: https://soam-dev.apps.silver.devops.gov.bc.ca
}
vars:secret [
clientId,
secret
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
vars {
baseUrl: http://localhost:8888
tokenRootUrl: https://soam-prod.apps.silver.devops.gov.bc.ca
}
vars:secret [
clientId,
secret
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
vars {
baseUrl: http://localhost:8888
tokenRootUrl: https://soam-test.apps.silver.devops.gov.bc.ca
}
vars:secret [
clientId,
secret
]

0 comments on commit ac2ddd7

Please sign in to comment.