Skip to content

Commit

Permalink
OPA-SpringBoot => OPA Spring Boot SDK
Browse files Browse the repository at this point in the history
  • Loading branch information
chendrix committed Jul 25, 2024
1 parent 210e8ee commit fc86043
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OPA-SpringBoot Changelog
# OPA Spring Boot SDK Changelog

## v0.0.5 (unreleased)

Expand All @@ -18,4 +18,4 @@

## v0.0.1

* Initial release of OPA-SpringBoot
* Initial release of the OPA Spring Boot SDK
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OPA-SpringBoot Development
# OPA Spring Boot SDK Development

## Changelog Conventions

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion scripts/build_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ cat <<'EOF' > "$TEMP/index.html"
<title>Page Redirection</title>
</head>
<body>
<a href='./javadoc'>redirect to OPA-SpringBoot javadoc</a>.
<a href='./javadoc'>redirect to OPA Spring Boot SDK javadoc</a>.
</body>
</html>
EOF
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ private Map<String, Object> 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.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/styra/opa/springboot/OPAResponse.java
Original file line number Diff line number Diff line change
Expand Up @@ -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).
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit fc86043

Please sign in to comment.