artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 15:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change devops path to system in v5.1.0 and v6.0.0

Browse Source
This commit is contained in:
simonredfern 2025-11-26 23:58:12 +01:00
parent f09dba09a7
commit 81ee35aae8
6 changed files with 31 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
obp-api/src/main/scala/code/api/util/ApiTag.scala
View File

@ -78,6 +78,7 @@ object ApiTag {
val apiTagRateLimits = ResourceDocTag("Rate-Limits")
val apiTagCounterpartyLimits = ResourceDocTag("Counterparty-Limits")
val apiTagDevOps = ResourceDocTag("DevOps")
val apiTagSystem = ResourceDocTag("System")
val apiTagApiCollection = ResourceDocTag("Api-Collection")

8
obp-api/src/main/scala/code/api/v5_1_0/APIMethods510.scala
View File

@ -243,7 +243,7 @@ trait APIMethods510 {
implementedInApiVersion,
nameOf(logCacheEndpoint),
"GET",
"/devops/log-cache/LOG_LEVEL",
"/system/log-cache/LOG_LEVEL",
"Get Log Cache",
"""Returns information about:
|
@ -253,16 +253,16 @@ trait APIMethods510 {
|* limit - Maximum number of log entries to return
|* offset - Number of log entries to skip (for pagination)
|
|Example: GET /dev-ops/log-cache/INFO?limit=50&offset=100
|Example: GET /system/log-cache/INFO?limit=50&offset=100
""",
EmptyBody,
EmptyBody,
List($UserNotLoggedIn, UnknownError),
apiTagDevOps :: apiTagApi :: Nil,
apiTagSystem :: apiTagApi :: Nil,
Some(List(canGetAllLevelLogsAtAllBanks)))
lazy val logCacheEndpoint: OBPEndpoint = {
case "devops" :: "log-cache" :: logLevel :: Nil JsonGet _ =>
case "system" :: "log-cache" :: logLevel :: Nil JsonGet _ =>
cc =>
implicit val ec = EndpointContext(Some(cc))
for {

12
obp-api/src/main/scala/code/api/v6_0_0/APIMethods600.scala
View File

@ -847,7 +847,7 @@ trait APIMethods600 {
implementedInApiVersion,
nameOf(getMigrations),
"GET",
"/devops/migrations",
"/system/migrations",
"Get Database Migrations",
s"""Get all database migration script logs.
|
@ -865,12 +865,12 @@ trait APIMethods600 {
UserHasMissingRoles,
UnknownError
),
List(apiTagDevOps, apiTagApi),
List(apiTagSystem, apiTagApi),
Some(List(canGetMigrations))
)
lazy val getMigrations: OBPEndpoint = {
case "devops" :: "migrations" :: Nil JsonGet _ => { cc =>
case "system" :: "migrations" :: Nil JsonGet _ => { cc =>
implicit val ec = EndpointContext(Some(cc))
for {
(Full(u), callContext) <- authenticatedAccess(cc)
@ -1148,7 +1148,7 @@ trait APIMethods600 {
implementedInApiVersion,
nameOf(getConnectorMethodNames),
"GET",
"/devops/connector-method-names",
"/system/connector-method-names",
"Get Connector Method Names",
s"""Get the list of all available connector method names.
|
@ -1201,12 +1201,12 @@ trait APIMethods600 {
UserHasMissingRoles,
UnknownError
),
List(apiTagDevOps, apiTagMethodRouting, apiTagApi),
List(apiTagSystem, apiTagMethodRouting, apiTagApi),
Some(List(canGetMethodRoutings))
)
lazy val getConnectorMethodNames: OBPEndpoint = {
case "devops" :: "connector-method-names" :: Nil JsonGet _ =>
case "system" :: "connector-method-names" :: Nil JsonGet _ =>
cc => implicit val ec = EndpointContext(Some(cc))
for {
(Full(u), callContext) <- authenticatedAccess(cc)

2
obp-api/src/main/scala/code/api/v6_0_0/OBPAPI6_0_0.scala
View File

@ -75,7 +75,7 @@ object OBPAPI6_0_0 extends OBPRestHelper
lazy val endpointsOf6_0_0 = getEndpoints(Implementations6_0_0)
// Exclude v5.1.0 root endpoint since v6.0.0 has its own
lazy val endpointsOf5_1_0_without_root = OBPAPI5_1_0.routes -- List(Implementations5_1_0.root)
lazy val endpointsOf5_1_0_without_root = OBPAPI5_1_0.routes.filterNot(_ == Implementations5_1_0.root)
lazy val excludeEndpoints =
nameOf(Implementations3_0_0.getUserByUsername) :: // following 4 endpoints miss Provider parameter in the URL, we introduce new ones in V600.

30
obp-api/src/test/scala/code/api/v5_1_0/LogCacheEndpointTest.scala
View File

@ -26,7 +26,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
feature(s"test $ApiEndpoint1 version $VersionOfApi - Unauthorized access") {
scenario("We will call the endpoint without user credentials", ApiEndpoint1, VersionOfApi) {
When("We make a request v5.1.0")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET
val request = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET
val response = makeGetRequest(request)
Then("We should get a 401")
response.code should equal(401)
@ -37,7 +37,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
feature(s"test $ApiEndpoint1 version $VersionOfApi - Missing entitlement") {
scenario("We will call the endpoint with user credentials but without proper entitlement", ApiEndpoint1, VersionOfApi) {
When("We make a request v5.1.0")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1)
val request = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1)
val response = makeGetRequest(request)
Then("error should be " + UserHasMissingRoles + CanGetAllLevelLogsAtAllBanks)
response.code should equal(403)
@ -51,7 +51,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetAllLevelLogsAtAllBanks.toString)
When("We make a request to get log cache")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1)
val request = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1)
val response = makeGetRequest(request)
Then("We should get a successful response")
@ -69,7 +69,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetAllLevelLogsAtAllBanks.toString)
When("We make a request with limit parameter")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "5"))
val request = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "5"))
val response = makeGetRequest(request)
Then("We should get a successful response")
@ -88,7 +88,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetAllLevelLogsAtAllBanks.toString)
When("We make a request with offset parameter")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("offset", "2"))
val request = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("offset", "2"))
val response = makeGetRequest(request)
Then("We should get a successful response")
@ -106,7 +106,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetAllLevelLogsAtAllBanks.toString)
When("We make a request with both limit and offset parameters")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "3"), ("offset", "1"))
val request = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "3"), ("offset", "1"))
val response = makeGetRequest(request)
Then("We should get a successful response")
@ -125,7 +125,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetAllLevelLogsAtAllBanks.toString)
When("We make a request with zero limit")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "0"))
val request = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "0"))
val response = makeGetRequest(request)
Then("We should get a bad request response")
@ -142,7 +142,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetAllLevelLogsAtAllBanks.toString)
When("We make a request with very large offset")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("offset", "10000"))
val request = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("offset", "10000"))
val response = makeGetRequest(request)
Then("We should get a successful response")
@ -159,7 +159,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetAllLevelLogsAtAllBanks.toString)
When("We make a request with minimum valid limit (1)")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "1"))
val request = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "1"))
val response = makeGetRequest(request)
Then("We should get a successful response")
@ -181,7 +181,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
val logLevels = List("DEBUG", "INFO", "WARN", "ERROR", "ALL")
logLevels.foreach { logLevel =>
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / logLevel).GET <@(user1) <<? List(("limit", "2"), ("offset", "0"))
val request = (v5_1_0_Request / "system" / "log-cache" / logLevel).GET <@(user1) <<? List(("limit", "2"), ("offset", "0"))
val response = makeGetRequest(request)
Then(s"We should get successful response for log level $logLevel")
@ -200,7 +200,7 @@ class LogCacheEndpointTest extends V510ServerSetup {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetAllLevelLogsAtAllBanks.toString)
When("We make a request with invalid log level")
val request = (v5_1_0_Request / "dev-ops" / "log-cache" / "INVALID_LEVEL").GET <@(user1)
val request = (v5_1_0_Request / "system" / "log-cache" / "INVALID_LEVEL").GET <@(user1)
val response = makeGetRequest(request)
Then("We should get a bad request response")
@ -214,28 +214,28 @@ class LogCacheEndpointTest extends V510ServerSetup {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetAllLevelLogsAtAllBanks.toString)
When("We test with non-numeric limit parameter")
val requestInvalidLimit = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "abc"))
val requestInvalidLimit = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "abc"))
val responseInvalidLimit = makeGetRequest(requestInvalidLimit)
Then("We should get a bad request response")
responseInvalidLimit.code should equal(400)
When("We test with non-numeric offset parameter")
val requestInvalidOffset = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("offset", "xyz"))
val requestInvalidOffset = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("offset", "xyz"))
val responseInvalidOffset = makeGetRequest(requestInvalidOffset)
Then("We should get a bad request response")
responseInvalidOffset.code should equal(400)
When("We test with negative limit parameter")
val requestNegativeLimit = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "-1"))
val requestNegativeLimit = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("limit", "-1"))
val responseNegativeLimit = makeGetRequest(requestNegativeLimit)
Then("We should get a bad request response")
responseNegativeLimit.code should equal(400)
When("We test with negative offset parameter")
val requestNegativeOffset = (v5_1_0_Request / "dev-ops" / "log-cache" / "INFO").GET <@(user1) <<? List(("offset", "-1"))
val requestNegativeOffset = (v5_1_0_Request / "system" / "log-cache" / "INFO").GET <@(user1) <<? List(("offset", "-1"))
val responseNegativeOffset = makeGetRequest(requestNegativeOffset)
Then("We should get a bad request response")

8
obp-api/src/test/scala/code/api/v6_0_0/MigrationsTest.scala
View File

@ -49,7 +49,7 @@ class MigrationsTest extends V600ServerSetup {
feature(s"test $ApiEndpoint1 version $VersionOfApi - Unauthorized access") {
scenario("We will call the endpoint without user credentials", ApiEndpoint1, VersionOfApi) {
When("We make a request v6.0.0")
val request600 = (v6_0_0_Request / "devops" / "migrations").GET
val request600 = (v6_0_0_Request / "system" / "migrations").GET
val response600 = makeGetRequest(request600)
Then("We should get a 401")
response600.code should equal(401)
@ -60,7 +60,7 @@ class MigrationsTest extends V600ServerSetup {
feature(s"test $ApiEndpoint1 version $VersionOfApi - Authorized access") {
scenario("We will call the endpoint without proper Role", ApiEndpoint1, VersionOfApi) {
When("We make a request v6.0.0 without a proper role")
val request600 = (v6_0_0_Request / "devops" / "migrations").GET <@ (user1)
val request600 = (v6_0_0_Request / "system" / "migrations").GET <@ (user1)
val response600 = makeGetRequest(request600)
Then("We should get a 403")
response600.code should equal(403)
@ -71,7 +71,7 @@ class MigrationsTest extends V600ServerSetup {
scenario("We will call the endpoint with proper Role", ApiEndpoint1, VersionOfApi) {
When("We make a request v6.0.0 with a proper role")
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetMigrations.toString)
val request600 = (v6_0_0_Request / "devops" / "migrations").GET <@ (user1)
val request600 = (v6_0_0_Request / "system" / "migrations").GET <@ (user1)
val response600 = makeGetRequest(request600)
Then("We should get a 200")
response600.code should equal(200)
@ -86,7 +86,7 @@ class MigrationsTest extends V600ServerSetup {
scenario("We will verify the response structure contains expected fields", ApiEndpoint1, VersionOfApi) {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetMigrations.toString)
When("We make a request v6.0.0")
val request600 = (v6_0_0_Request / "devops" / "migrations").GET <@ (user1)
val request600 = (v6_0_0_Request / "system" / "migrations").GET <@ (user1)
val response600 = makeGetRequest(request600)
Then("We should get a 200")
response600.code should equal(200)