You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@polaris.apache.org by "adutra (via GitHub)" <gi...@apache.org> on 2026/07/16 13:00:38 UTC

[PR] Add missing idempotency generated docs [polaris]

adutra opened a new pull request, #5069:
URL: https://github.com/apache/polaris/pull/5069

   <!--
   📝 Describe what changes you're proposing, especially breaking or user-facing changes. 
   📖 See https://github.com/apache/polaris/blob/main/CONTRIBUTING.md for more.
   -->
   
   ## Checklist
   - [ ] 🛡️ Don't disclose security issues! (contact security@apache.org)
   - [ ] 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
   - [ ] 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
   - [ ] 💡 Added comments for complex logic
   - [ ] 🧾 Updated `CHANGELOG.md` (if needed)
   - [ ] 📚 Updated documentation in `site/content/in-dev/unreleased` (if needed)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Add missing idempotency generated docs [polaris]

Posted by "adutra (via GitHub)" <gi...@apache.org>.

adutra merged PR #5069:
URL: https://github.com/apache/polaris/pull/5069


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Add missing idempotency generated docs [polaris]

Posted by "adutra (via GitHub)" <gi...@apache.org>.

adutra commented on code in PR #5069:
URL: https://github.com/apache/polaris/pull/5069#discussion_r3596105421


##########
site/content/in-dev/unreleased/configuration/config-sections/smallrye-polaris_idempotency.md:
##########
@@ -0,0 +1,33 @@
+---
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+title: smallrye-polaris_idempotency
+build:
+  list: never
+  render: never
+---
+
+Deploy-time configuration for entity-property (single-transaction) idempotency. 
+
+This model embeds the `Idempotency-Key` directly into the `internalProperties` of  the entity created by the originating operation, so the key and the operation commit atomically.  There is no separate idempotency store, so the configuration surface is intentionally minimal:  just a feature flag and the key TTL.
+
+| Property | Default Value | Type | Description |
+|----------|---------------|------|-------------|
+| `polaris.idempotency.enabled` | `false` | `boolean` | Whether handler-level idempotency is enabled. When `false` the handlers ignore the `Idempotency-Key` header entirely and never stamp or read idempotency keys.  |
+| `polaris.idempotency.ttl` | `PT5M` | `duration` | TTL for newly recorded idempotency keys. A retry that arrives within this window of a  successful create replays the existing table; after it elapses the key is treated as absent and  dropped inline on the entity's next write.  |

Review Comment:
   Good catch on the process concern. I've reproduced the issue: `IdempotencyConfiguration` was added in ef17e01aa6 but the config-docs generator (`copyConfigSectionsToSite` Gradle task) was never re-run to produce its section page — so the file was added manually.
   
   I've now run the generator on a separate branch (`fix-docs-generator`) and it produces the exact same content, with correct single-pipe table delimiters. I'll close this PR and replace it with the properly-generated output from that branch.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Add missing idempotency generated docs [polaris]

Posted by "Copilot (via GitHub)" <gi...@apache.org>.

Copilot commented on code in PR #5069:
URL: https://github.com/apache/polaris/pull/5069#discussion_r3595626313


##########
site/content/in-dev/unreleased/configuration/config-sections/smallrye-polaris_idempotency.md:
##########
@@ -0,0 +1,33 @@
+---
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+title: smallrye-polaris_idempotency
+build:
+  list: never
+  render: never
+---
+
+Deploy-time configuration for entity-property (single-transaction) idempotency. 
+
+This model embeds the `Idempotency-Key` directly into the `internalProperties` of  the entity created by the originating operation, so the key and the operation commit atomically.  There is no separate idempotency store, so the configuration surface is intentionally minimal:  just a feature flag and the key TTL.
+
+| Property | Default Value | Type | Description |
+|----------|---------------|------|-------------|
+| `polaris.idempotency.enabled` | `false` | `boolean` | Whether handler-level idempotency is enabled. When `false` the handlers ignore the `Idempotency-Key` header entirely and never stamp or read idempotency keys.  |
+| `polaris.idempotency.ttl` | `PT5M` | `duration` | TTL for newly recorded idempotency keys. A retry that arrives within this window of a  successful create replays the existing table; after it elapses the key is treated as absent and  dropped inline on the entity's next write.  |

Review Comment:
   The markdown table header/separator lines start with `||` instead of `|` (unlike the other generated config-section docs such as `smallrye-polaris_async.md`). This will render an extra empty column / misaligned table in many markdown renderers. Since this directory is generated via the config-docs generator, please fix the generator/source input and re-generate rather than editing the output by hand.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@polaris.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org