From 26d5c9684132991fee349b51cfb63d1635ec6dd2 Mon Sep 17 00:00:00 2001 From: Declan Teevan Date: Mon, 29 Sep 2025 22:58:14 +0100 Subject: [PATCH] feat: base bruno routes generated from OpenAPI v3 spec --- CONTRIBUTING.md | 2 +- tests/bruno/.gitkeep | 0 tests/bruno/auth/AuthService_GetJwks.bru | 11 +++++++++++ .../bruno/auth/AuthService_LoginPassword.bru | 18 ++++++++++++++++++ tests/bruno/auth/AuthService_SetPassword.bru | 18 ++++++++++++++++++ .../View information about the service.bru | 11 +++++++++++ tests/bruno/auth/folder.bru | 7 +++++++ tests/bruno/bruno.json | 13 +++++++++++++ tests/bruno/collection.bru | 7 +++++++ tests/bruno/environments/Environment 1.bru | 3 +++ ...eway - shows the current user's orders.bru | 16 ++++++++++++++++ tests/bruno/order/OrderService_PlaceOrder.bru | 19 +++++++++++++++++++ tests/bruno/order/OrderService_ViewOrder.bru | 15 +++++++++++++++ .../View information about the service.bru | 11 +++++++++++ tests/bruno/order/folder.bru | 7 +++++++ .../payment/PaymentService_ViewBalance.bru | 15 +++++++++++++++ .../PaymentService_ViewTransaction.bru | 15 +++++++++++++++ .../View information about the service.bru | 11 +++++++++++ tests/bruno/payment/folder.bru | 7 +++++++ .../product/ProductService_ViewProduct.bru | 15 +++++++++++++++ .../product/ProductService_ViewProducts.bru | 11 +++++++++++ .../View information about the service.bru | 11 +++++++++++ tests/bruno/product/folder.bru | 7 +++++++ .../shipping/ShippingService_ViewShipment.bru | 15 +++++++++++++++ .../ShippingService_ViewShipmentManifest.bru | 15 +++++++++++++++ .../View information about the service.bru | 11 +++++++++++ tests/bruno/shipping/folder.bru | 7 +++++++ tests/bruno/user/UserService_RegisterUser.bru | 18 ++++++++++++++++++ tests/bruno/user/UserService_ViewUser.bru | 15 +++++++++++++++ .../View information about the service.bru | 11 +++++++++++ tests/bruno/user/folder.bru | 7 +++++++ .../View information about the service.bru | 11 +++++++++++ .../WarehouseService_ViewProductStock.bru | 15 +++++++++++++++ .../WarehouseService_ViewReservation.bru | 15 +++++++++++++++ tests/bruno/warehouse/folder.bru | 7 +++++++ 35 files changed, 396 insertions(+), 1 deletion(-) delete mode 100644 tests/bruno/.gitkeep create mode 100644 tests/bruno/auth/AuthService_GetJwks.bru create mode 100644 tests/bruno/auth/AuthService_LoginPassword.bru create mode 100644 tests/bruno/auth/AuthService_SetPassword.bru create mode 100644 tests/bruno/auth/View information about the service.bru create mode 100644 tests/bruno/auth/folder.bru create mode 100644 tests/bruno/bruno.json create mode 100644 tests/bruno/collection.bru create mode 100644 tests/bruno/environments/Environment 1.bru create mode 100644 tests/bruno/order/Get a list of a customer's orders.-If accessed through the gateway - shows the current user's orders.bru create mode 100644 tests/bruno/order/OrderService_PlaceOrder.bru create mode 100644 tests/bruno/order/OrderService_ViewOrder.bru create mode 100644 tests/bruno/order/View information about the service.bru create mode 100644 tests/bruno/order/folder.bru create mode 100644 tests/bruno/payment/PaymentService_ViewBalance.bru create mode 100644 tests/bruno/payment/PaymentService_ViewTransaction.bru create mode 100644 tests/bruno/payment/View information about the service.bru create mode 100644 tests/bruno/payment/folder.bru create mode 100644 tests/bruno/product/ProductService_ViewProduct.bru create mode 100644 tests/bruno/product/ProductService_ViewProducts.bru create mode 100644 tests/bruno/product/View information about the service.bru create mode 100644 tests/bruno/product/folder.bru create mode 100644 tests/bruno/shipping/ShippingService_ViewShipment.bru create mode 100644 tests/bruno/shipping/ShippingService_ViewShipmentManifest.bru create mode 100644 tests/bruno/shipping/View information about the service.bru create mode 100644 tests/bruno/shipping/folder.bru create mode 100644 tests/bruno/user/UserService_RegisterUser.bru create mode 100644 tests/bruno/user/UserService_ViewUser.bru create mode 100644 tests/bruno/user/View information about the service.bru create mode 100644 tests/bruno/user/folder.bru create mode 100644 tests/bruno/warehouse/View information about the service.bru create mode 100644 tests/bruno/warehouse/WarehouseService_ViewProductStock.bru create mode 100644 tests/bruno/warehouse/WarehouseService_ViewReservation.bru create mode 100644 tests/bruno/warehouse/folder.bru diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5c7e84..d31f976 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,7 +144,7 @@ A full deployment will, in the nature of microservices being independent (etc), ### Improving The Documentation -Feel free to open a PR if you'd like to contribute updates which add to or improve the current documentation. There currently isn't standard that the documentation is following. +Feel free to open a PR if you'd like to contribute updates which add to or improve the current documentation. There currently isn't a standard that the documentation is following. I do lint my Markdown files using [markdownlint](https://github.com/DavidAnson/markdownlint). diff --git a/tests/bruno/.gitkeep b/tests/bruno/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/tests/bruno/auth/AuthService_GetJwks.bru b/tests/bruno/auth/AuthService_GetJwks.bru new file mode 100644 index 0000000..b8f3a50 --- /dev/null +++ b/tests/bruno/auth/AuthService_GetJwks.bru @@ -0,0 +1,11 @@ +meta { + name: AuthService_GetJwks + type: http + seq: 1 +} + +get { + url: {{baseUrl}}/v1/auth/jwks + body: none + auth: inherit +} diff --git a/tests/bruno/auth/AuthService_LoginPassword.bru b/tests/bruno/auth/AuthService_LoginPassword.bru new file mode 100644 index 0000000..b52a334 --- /dev/null +++ b/tests/bruno/auth/AuthService_LoginPassword.bru @@ -0,0 +1,18 @@ +meta { + name: AuthService_LoginPassword + type: http + seq: 2 +} + +post { + url: {{baseUrl}}/v1/auth/login + body: json + auth: inherit +} + +body:json { + { + "userId": "", + "password": "" + } +} diff --git a/tests/bruno/auth/AuthService_SetPassword.bru b/tests/bruno/auth/AuthService_SetPassword.bru new file mode 100644 index 0000000..39067f9 --- /dev/null +++ b/tests/bruno/auth/AuthService_SetPassword.bru @@ -0,0 +1,18 @@ +meta { + name: AuthService_SetPassword + type: http + seq: 3 +} + +post { + url: {{baseUrl}}/v1/auth/password + body: json + auth: inherit +} + +body:json { + { + "userId": "", + "password": "" + } +} diff --git a/tests/bruno/auth/View information about the service.bru b/tests/bruno/auth/View information about the service.bru new file mode 100644 index 0000000..7db484a --- /dev/null +++ b/tests/bruno/auth/View information about the service.bru @@ -0,0 +1,11 @@ +meta { + name: View information about the service. + type: http + seq: 4 +} + +get { + url: {{baseUrl}}/v1/auth/service + body: none + auth: inherit +} diff --git a/tests/bruno/auth/folder.bru b/tests/bruno/auth/folder.bru new file mode 100644 index 0000000..cec67bf --- /dev/null +++ b/tests/bruno/auth/folder.bru @@ -0,0 +1,7 @@ +meta { + name: auth +} + +auth { + mode: inherit +} diff --git a/tests/bruno/bruno.json b/tests/bruno/bruno.json new file mode 100644 index 0000000..c068c54 --- /dev/null +++ b/tests/bruno/bruno.json @@ -0,0 +1,13 @@ +{ + "version": "1", + "name": "Stocklet", + "type": "collection", + "ignore": [ + "node_modules", + ".git" + ], + "presets": { + "requestType": "http", + "requestUrl": "http://localhost/" + } +} \ No newline at end of file diff --git a/tests/bruno/collection.bru b/tests/bruno/collection.bru new file mode 100644 index 0000000..a488ac8 --- /dev/null +++ b/tests/bruno/collection.bru @@ -0,0 +1,7 @@ +meta { + name: Stocklet +} + +auth { + mode: none +} diff --git a/tests/bruno/environments/Environment 1.bru b/tests/bruno/environments/Environment 1.bru new file mode 100644 index 0000000..6d65bef --- /dev/null +++ b/tests/bruno/environments/Environment 1.bru @@ -0,0 +1,3 @@ +vars { + baseUrl: http://localhost +} diff --git a/tests/bruno/order/Get a list of a customer's orders.-If accessed through the gateway - shows the current user's orders.bru b/tests/bruno/order/Get a list of a customer's orders.-If accessed through the gateway - shows the current user's orders.bru new file mode 100644 index 0000000..da5854e --- /dev/null +++ b/tests/bruno/order/Get a list of a customer's orders.-If accessed through the gateway - shows the current user's orders.bru @@ -0,0 +1,16 @@ +meta { + name: Get a list of a customer's orders. +If accessed through the gateway - shows the current user's orders. + type: http + seq: 1 +} + +get { + url: {{baseUrl}}/v1/order/list + body: none + auth: inherit +} + +params:query { + ~customerId: +} diff --git a/tests/bruno/order/OrderService_PlaceOrder.bru b/tests/bruno/order/OrderService_PlaceOrder.bru new file mode 100644 index 0000000..3055be1 --- /dev/null +++ b/tests/bruno/order/OrderService_PlaceOrder.bru @@ -0,0 +1,19 @@ +meta { + name: OrderService_PlaceOrder + type: http + seq: 3 +} + +post { + url: {{baseUrl}}/v1/order/place + body: json + auth: inherit +} + +params:query { + ~customerId: +} + +body:json { + {} +} diff --git a/tests/bruno/order/OrderService_ViewOrder.bru b/tests/bruno/order/OrderService_ViewOrder.bru new file mode 100644 index 0000000..1687268 --- /dev/null +++ b/tests/bruno/order/OrderService_ViewOrder.bru @@ -0,0 +1,15 @@ +meta { + name: OrderService_ViewOrder + type: http + seq: 2 +} + +get { + url: {{baseUrl}}/v1/order/orders/:orderId + body: none + auth: inherit +} + +params:path { + orderId: +} diff --git a/tests/bruno/order/View information about the service.bru b/tests/bruno/order/View information about the service.bru new file mode 100644 index 0000000..87baac9 --- /dev/null +++ b/tests/bruno/order/View information about the service.bru @@ -0,0 +1,11 @@ +meta { + name: View information about the service. + type: http + seq: 4 +} + +get { + url: {{baseUrl}}/v1/order/service + body: none + auth: inherit +} diff --git a/tests/bruno/order/folder.bru b/tests/bruno/order/folder.bru new file mode 100644 index 0000000..7131073 --- /dev/null +++ b/tests/bruno/order/folder.bru @@ -0,0 +1,7 @@ +meta { + name: order +} + +auth { + mode: inherit +} diff --git a/tests/bruno/payment/PaymentService_ViewBalance.bru b/tests/bruno/payment/PaymentService_ViewBalance.bru new file mode 100644 index 0000000..affcf5c --- /dev/null +++ b/tests/bruno/payment/PaymentService_ViewBalance.bru @@ -0,0 +1,15 @@ +meta { + name: PaymentService_ViewBalance + type: http + seq: 1 +} + +get { + url: {{baseUrl}}/v1/payment/balance/:customerId + body: none + auth: inherit +} + +params:path { + customerId: +} diff --git a/tests/bruno/payment/PaymentService_ViewTransaction.bru b/tests/bruno/payment/PaymentService_ViewTransaction.bru new file mode 100644 index 0000000..a251870 --- /dev/null +++ b/tests/bruno/payment/PaymentService_ViewTransaction.bru @@ -0,0 +1,15 @@ +meta { + name: PaymentService_ViewTransaction + type: http + seq: 3 +} + +get { + url: {{baseUrl}}/v1/payment/transaction/:transactionId + body: none + auth: inherit +} + +params:path { + transactionId: +} diff --git a/tests/bruno/payment/View information about the service.bru b/tests/bruno/payment/View information about the service.bru new file mode 100644 index 0000000..89e4281 --- /dev/null +++ b/tests/bruno/payment/View information about the service.bru @@ -0,0 +1,11 @@ +meta { + name: View information about the service. + type: http + seq: 2 +} + +get { + url: {{baseUrl}}/v1/payment/service + body: none + auth: inherit +} diff --git a/tests/bruno/payment/folder.bru b/tests/bruno/payment/folder.bru new file mode 100644 index 0000000..d2d1053 --- /dev/null +++ b/tests/bruno/payment/folder.bru @@ -0,0 +1,7 @@ +meta { + name: payment +} + +auth { + mode: inherit +} diff --git a/tests/bruno/product/ProductService_ViewProduct.bru b/tests/bruno/product/ProductService_ViewProduct.bru new file mode 100644 index 0000000..fd991aa --- /dev/null +++ b/tests/bruno/product/ProductService_ViewProduct.bru @@ -0,0 +1,15 @@ +meta { + name: ProductService_ViewProduct + type: http + seq: 3 +} + +get { + url: {{baseUrl}}/v1/product/:id + body: none + auth: inherit +} + +params:path { + id: +} diff --git a/tests/bruno/product/ProductService_ViewProducts.bru b/tests/bruno/product/ProductService_ViewProducts.bru new file mode 100644 index 0000000..7cf0347 --- /dev/null +++ b/tests/bruno/product/ProductService_ViewProducts.bru @@ -0,0 +1,11 @@ +meta { + name: ProductService_ViewProducts + type: http + seq: 1 +} + +get { + url: {{baseUrl}}/v1/product/list + body: none + auth: inherit +} diff --git a/tests/bruno/product/View information about the service.bru b/tests/bruno/product/View information about the service.bru new file mode 100644 index 0000000..c667198 --- /dev/null +++ b/tests/bruno/product/View information about the service.bru @@ -0,0 +1,11 @@ +meta { + name: View information about the service. + type: http + seq: 2 +} + +get { + url: {{baseUrl}}/v1/product/service + body: none + auth: inherit +} diff --git a/tests/bruno/product/folder.bru b/tests/bruno/product/folder.bru new file mode 100644 index 0000000..7bc9ec7 --- /dev/null +++ b/tests/bruno/product/folder.bru @@ -0,0 +1,7 @@ +meta { + name: product +} + +auth { + mode: inherit +} diff --git a/tests/bruno/shipping/ShippingService_ViewShipment.bru b/tests/bruno/shipping/ShippingService_ViewShipment.bru new file mode 100644 index 0000000..cd1bd9b --- /dev/null +++ b/tests/bruno/shipping/ShippingService_ViewShipment.bru @@ -0,0 +1,15 @@ +meta { + name: ShippingService_ViewShipment + type: http + seq: 2 +} + +get { + url: {{baseUrl}}/v1/shipping/shipment/:shipmentId + body: none + auth: inherit +} + +params:path { + shipmentId: +} diff --git a/tests/bruno/shipping/ShippingService_ViewShipmentManifest.bru b/tests/bruno/shipping/ShippingService_ViewShipmentManifest.bru new file mode 100644 index 0000000..3dd047e --- /dev/null +++ b/tests/bruno/shipping/ShippingService_ViewShipmentManifest.bru @@ -0,0 +1,15 @@ +meta { + name: ShippingService_ViewShipmentManifest + type: http + seq: 3 +} + +get { + url: {{baseUrl}}/v1/shipping/shipment/:shipmentId/manifest + body: none + auth: inherit +} + +params:path { + shipmentId: +} diff --git a/tests/bruno/shipping/View information about the service.bru b/tests/bruno/shipping/View information about the service.bru new file mode 100644 index 0000000..f902821 --- /dev/null +++ b/tests/bruno/shipping/View information about the service.bru @@ -0,0 +1,11 @@ +meta { + name: View information about the service. + type: http + seq: 1 +} + +get { + url: {{baseUrl}}/v1/shipping/service + body: none + auth: inherit +} diff --git a/tests/bruno/shipping/folder.bru b/tests/bruno/shipping/folder.bru new file mode 100644 index 0000000..93110f9 --- /dev/null +++ b/tests/bruno/shipping/folder.bru @@ -0,0 +1,7 @@ +meta { + name: shipping +} + +auth { + mode: inherit +} diff --git a/tests/bruno/user/UserService_RegisterUser.bru b/tests/bruno/user/UserService_RegisterUser.bru new file mode 100644 index 0000000..7cad755 --- /dev/null +++ b/tests/bruno/user/UserService_RegisterUser.bru @@ -0,0 +1,18 @@ +meta { + name: UserService_RegisterUser + type: http + seq: 1 +} + +post { + url: {{baseUrl}}/v1/user/register + body: none + auth: inherit +} + +params:query { + firstName: + lastName: + email: + password: +} diff --git a/tests/bruno/user/UserService_ViewUser.bru b/tests/bruno/user/UserService_ViewUser.bru new file mode 100644 index 0000000..6cf752b --- /dev/null +++ b/tests/bruno/user/UserService_ViewUser.bru @@ -0,0 +1,15 @@ +meta { + name: UserService_ViewUser + type: http + seq: 3 +} + +get { + url: {{baseUrl}}/v1/user/users/:id + body: none + auth: inherit +} + +params:path { + id: +} diff --git a/tests/bruno/user/View information about the service.bru b/tests/bruno/user/View information about the service.bru new file mode 100644 index 0000000..ffa88cd --- /dev/null +++ b/tests/bruno/user/View information about the service.bru @@ -0,0 +1,11 @@ +meta { + name: View information about the service. + type: http + seq: 2 +} + +get { + url: {{baseUrl}}/v1/user/service + body: none + auth: inherit +} diff --git a/tests/bruno/user/folder.bru b/tests/bruno/user/folder.bru new file mode 100644 index 0000000..1fd6ce0 --- /dev/null +++ b/tests/bruno/user/folder.bru @@ -0,0 +1,7 @@ +meta { + name: user +} + +auth { + mode: inherit +} diff --git a/tests/bruno/warehouse/View information about the service.bru b/tests/bruno/warehouse/View information about the service.bru new file mode 100644 index 0000000..34a9318 --- /dev/null +++ b/tests/bruno/warehouse/View information about the service.bru @@ -0,0 +1,11 @@ +meta { + name: View information about the service. + type: http + seq: 3 +} + +get { + url: {{baseUrl}}/v1/warehouse/service + body: none + auth: inherit +} diff --git a/tests/bruno/warehouse/WarehouseService_ViewProductStock.bru b/tests/bruno/warehouse/WarehouseService_ViewProductStock.bru new file mode 100644 index 0000000..5d53e50 --- /dev/null +++ b/tests/bruno/warehouse/WarehouseService_ViewProductStock.bru @@ -0,0 +1,15 @@ +meta { + name: WarehouseService_ViewProductStock + type: http + seq: 1 +} + +get { + url: {{baseUrl}}/v1/warehouse/product/:productId + body: none + auth: inherit +} + +params:path { + productId: +} diff --git a/tests/bruno/warehouse/WarehouseService_ViewReservation.bru b/tests/bruno/warehouse/WarehouseService_ViewReservation.bru new file mode 100644 index 0000000..f8e95c3 --- /dev/null +++ b/tests/bruno/warehouse/WarehouseService_ViewReservation.bru @@ -0,0 +1,15 @@ +meta { + name: WarehouseService_ViewReservation + type: http + seq: 2 +} + +get { + url: {{baseUrl}}/v1/warehouse/reservation/:reservationId + body: none + auth: inherit +} + +params:path { + reservationId: +} diff --git a/tests/bruno/warehouse/folder.bru b/tests/bruno/warehouse/folder.bru new file mode 100644 index 0000000..feac7fa --- /dev/null +++ b/tests/bruno/warehouse/folder.bru @@ -0,0 +1,7 @@ +meta { + name: warehouse +} + +auth { + mode: inherit +}