diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b6f956..5466bb1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# OPA-SpringBoot Changelog +# OPA Spring Boot SDK Changelog ## v0.0.5 (unreleased) @@ -18,4 +18,4 @@ ## v0.0.1 -* Initial release of OPA-SpringBoot +* Initial release of the OPA Spring Boot SDK diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 2ceb7bf..cc60b03 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,4 +1,4 @@ -# OPA-SpringBoot Development +# OPA Spring Boot SDK Development ## Changelog Conventions diff --git a/README.md b/README.md index c545a30..84b8fa0 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ > [!IMPORTANT] > The documentation for this SDK lives at [https://docs.styra.com/sdk](https://docs.styra.com/sdk), with reference documentation available at [https://styrainc.github.io/opa-springboot/javadoc](https://styrainc.github.io/opa-springboot/javadoc) -You can use the Styra OPA-SpringBoot SDK to connect [Open Policy Agent](https://www.openpolicyagent.org/) and [Enterprise OPA](https://www.styra.com/enterprise-opa/) deployments to your [Spring Boot](https://spring.io/projects/spring-boot) applications using the included [AuthorizationManager](https://docs.spring.io/spring-security/reference/servlet/authorization/architecture.html#_the_authorizationmanager) implementation. The policy inputs and outputs follow the [AuthZEN specification](https://openid.github.io/authzen). +You can use the Styra OPA Spring Boot SDK to connect [Open Policy Agent](https://www.openpolicyagent.org/) and [Enterprise OPA](https://www.styra.com/enterprise-opa/) deployments to your [Spring Boot](https://spring.io/projects/spring-boot) applications using the included [AuthorizationManager](https://docs.spring.io/spring-security/reference/servlet/authorization/architecture.html#_the_authorizationmanager) implementation. > [!IMPORTANT] > Would you prefer a plain Java API instead of Spring Boot? Check out the [OPA Java SDK](https://github.com/StyraInc/opa-java). diff --git a/scripts/build_docs.sh b/scripts/build_docs.sh index 79e6306..4988ca8 100755 --- a/scripts/build_docs.sh +++ b/scripts/build_docs.sh @@ -39,7 +39,7 @@ cat <<'EOF' > "$TEMP/index.html" Page Redirection - redirect to OPA-SpringBoot javadoc. + redirect to OPA Spring Boot SDK javadoc. EOF diff --git a/src/main/java/com/styra/opa/springboot/OPAAuthorizationManager.java b/src/main/java/com/styra/opa/springboot/OPAAuthorizationManager.java index 860c980..318ac38 100644 --- a/src/main/java/com/styra/opa/springboot/OPAAuthorizationManager.java +++ b/src/main/java/com/styra/opa/springboot/OPAAuthorizationManager.java @@ -237,7 +237,7 @@ private Map makeRequestInput( /** * This method can be used to directly call OPA without generating an * AuthorizationDecision, which can be used to examine the OPA response. - * You should consider using the OPA-Java SDK (which OPA-SpringBoot depends + * You should consider using the OPA Java SDK (which the OPA Spring Boot SDK depends * on) directly rather than using this method, as it should not be needed * during normal use. */ diff --git a/src/main/java/com/styra/opa/springboot/OPAResponse.java b/src/main/java/com/styra/opa/springboot/OPAResponse.java index 5d087c1..58112de 100644 --- a/src/main/java/com/styra/opa/springboot/OPAResponse.java +++ b/src/main/java/com/styra/opa/springboot/OPAResponse.java @@ -5,7 +5,7 @@ import lombok.NoArgsConstructor; /** - * This class models the data to be returned from an OPA-SpringBoot policy. The + * This class models the data to be returned from an OPA Spring Boot SDK policy. The * structure of the response is defined by the AuthZEN spec * (https://openid.github.io/authzen). */ diff --git a/src/main/java/com/styra/opa/springboot/OPAResponseContext.java b/src/main/java/com/styra/opa/springboot/OPAResponseContext.java index d48c51c..b1a6d31 100644 --- a/src/main/java/com/styra/opa/springboot/OPAResponseContext.java +++ b/src/main/java/com/styra/opa/springboot/OPAResponseContext.java @@ -11,7 +11,7 @@ import java.util.Map; /** - * This class models the data to be returned from an OPA-SpringBoot policy + * This class models the data to be returned from an OPA Spring Boot SDK policy * under the context key. * * This corresponds to the Context object in the AuthZen spec, see: