Skip to content

chore: update version to v1.6.10 in API docs and internal info file#2943

Closed
omer-topal wants to merge 1 commit intomasterfrom
update/api-version-to-v1.6.10
Closed

chore: update version to v1.6.10 in API docs and internal info file#2943
omer-topal wants to merge 1 commit intomasterfrom
update/api-version-to-v1.6.10

Conversation

@omer-topal
Copy link
Copy Markdown
Contributor

@omer-topal omer-topal commented May 5, 2026

Summary by CodeRabbit

  • Chores

    • Released version v1.6.10 with updated API documentation and specifications across all formats
  • Refactor

    • Modified template rendering to use plain text processing, changing how special characters are handled in template output without HTML-specific escaping

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 2026

πŸ“ Walkthrough

Walkthrough

Version metadata is bumped from v1.6.9 to v1.6.10 across API documentation and internal version constants. Additionally, the template engine in bundle operations is switched from html/template to text/template to change escaping behavior.

Changes

Version Bump to v1.6.10

Layer / File(s) Summary
API Documentation Metadata
docs/api-reference/apidocs.swagger.json, docs/api-reference/openapi.json, docs/api-reference/openapiv2/apidocs.swagger.json, proto/base/v1/openapi.proto
OpenAPI and Swagger specification version fields updated from v1.6.9 to v1.6.10.
Internal Version Constant
internal/info.go
Version constant updated from v1.6.9 to v1.6.10, affecting banner and release metadata output.

Template Engine Change in Bundle Operations

Layer / File(s) Summary
Template Package Implementation
pkg/bundle/bundle.go
Template engine import changed from html/template to text/template, disabling HTML-specific escaping in relationship and attribute template rendering within Operation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Permify/permify#2739: Updates API/OpenAPI metadata version and internal Version constant in the same files.
  • Permify/permify#2828: Updates API/OpenAPI version strings and internal/info.go's Version constant across identical documentation and code files.
  • Permify/permify#2741: Performs the same version bump pattern across docs, internal/info.go, and proto OpenAPI specs.

Suggested reviewers

  • ucatbas

Poem

🐰 A version hops from point-six-nine,
To one-zero, oh how fine!
And templates shed their HTML chains,
Plain text now flows through bundle's veins.
Bump and switchβ€”the release is neat! ✨

πŸš₯ Pre-merge checks | βœ… 5
βœ… Passed checks (5 passed)
Check name Status Explanation
Description Check βœ… Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check βœ… Passed The title accurately describes the main change: updating the version from v1.6.9 to v1.6.10 across API documentation files and internal configuration.
Docstring Coverage βœ… Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check βœ… Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check βœ… Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
πŸ“ Generate docstrings
  • Create stacked PR
  • Commit on current branch
πŸ§ͺ Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update/api-version-to-v1.6.10

Tip

πŸ’¬ Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire orgβ€”no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-inβ€”scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

πŸ‘‰ Get started


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❀️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
pkg/bundle/bundle.go (1)

20-44: ⚑ Quick win

Extract a shared template-render helper to eliminate 4-way duplication.

All four loops share identical parse β†’ execute β†’ buffer logic; only the downstream converter (tuple.Tuple vs attribute.Attribute) differs. A small helper avoids having to touch four places the next time the template rendering needs to change (e.g., adding a FuncMap, tweaking error messages, or adding options).

♻️ Proposed refactor
+// renderTemplate parses and executes a single template string against the provided arguments,
+// returning the rendered result.
+func renderTemplate(s string, arguments map[string]string) (string, error) {
+	tmpl, err := template.New("template").Parse(s)
+	if err != nil {
+		return "", err
+	}
+	var buf bytes.Buffer
+	if err = tmpl.Execute(&buf, arguments); err != nil {
+		return "", err
+	}
+	return buf.String(), nil
+}

Then each loop body collapses to:

-		tmpl, err := template.New("template").Parse(w)
-		if err != nil {
-			return tb, ab, err
-		}
-		var buf bytes.Buffer
-		err = tmpl.Execute(&buf, arguments)
-		if err != nil {
-			return tb, ab, err
-		}
-		t, err := tuple.Tuple(buf.String())
+		rendered, err := renderTemplate(w, arguments)
+		if err != nil {
+			return tb, ab, err
+		}
+		t, err := tuple.Tuple(rendered)

(and equivalently for the three other loops, substituting attribute.Attribute where appropriate)

Also applies to: 56-80, 92-116, 128-152

πŸ€– Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@pkg/bundle/bundle.go` around lines 20 - 44, The four loops in
pkg/bundle/bundle.go duplicate parse β†’ execute β†’ buffer logic; extract a small
helper (e.g., renderTemplate(templateStr string, args interface{}) (string,
error)) and use it from each loop so you only call renderTemplate(w, arguments)
then pass the returned string into the downstream converter (tuple.Tuple or
attribute.Attribute) before calling wtc.Add / atc.Add / etc.; ensure the helper
centralizes template.New(...).Parse and tmpl.Execute error handling (and can
later accept a FuncMap) so the loop bodies become just a call to renderTemplate
plus the existing converter and Add calls.
πŸ€– Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@pkg/bundle/bundle.go`:
- Around line 20-44: The four loops in pkg/bundle/bundle.go duplicate parse β†’
execute β†’ buffer logic; extract a small helper (e.g., renderTemplate(templateStr
string, args interface{}) (string, error)) and use it from each loop so you only
call renderTemplate(w, arguments) then pass the returned string into the
downstream converter (tuple.Tuple or attribute.Attribute) before calling wtc.Add
/ atc.Add / etc.; ensure the helper centralizes template.New(...).Parse and
tmpl.Execute error handling (and can later accept a FuncMap) so the loop bodies
become just a call to renderTemplate plus the existing converter and Add calls.

ℹ️ Review info
βš™οΈ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 376f8113-8c73-451a-8345-df865545ba9b

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between b6fdfe2 and 256c7a2.

β›” Files ignored due to path filters (2)
  • go.work.sum is excluded by !**/*.sum
  • pkg/pb/base/v1/openapi.pb.go is excluded by !**/*.pb.go
πŸ“’ Files selected for processing (7)
  • coverage.txt
  • docs/api-reference/apidocs.swagger.json
  • docs/api-reference/openapi.json
  • docs/api-reference/openapiv2/apidocs.swagger.json
  • internal/info.go
  • pkg/bundle/bundle.go
  • proto/base/v1/openapi.proto

@omer-topal omer-topal closed this May 5, 2026
@omer-topal omer-topal deleted the update/api-version-to-v1.6.10 branch May 5, 2026 19:54
@github-actions github-actions Bot locked and limited conversation to collaborators May 5, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant