Skip to content

chore: update v3 OpenAPI specs to v3.667.0#18

Merged
Ed Fricker (beastawakens) merged 1 commit into
mainfrom
sync/v3.667.0
Jun 15, 2026
Merged

chore: update v3 OpenAPI specs to v3.667.0#18
Ed Fricker (beastawakens) merged 1 commit into
mainfrom
sync/v3.667.0

Conversation

@beastawakens

@beastawakens Ed Fricker (beastawakens) commented Jun 15, 2026

Copy link
Copy Markdown
Member

User description

Automated v3 OpenAPI spec update for v3.667.0.

Triggered by Dave Berenbaum (@dberenbaum) - assigned to you in case it needs a manual merge.


PR Type

enhancement


Description

  • Remove "6–8" count from liveness_images descriptions

  • Remove insufficientLiveness error examples from 400 responses

  • Update CHANGELOG for v3.667.0


Diagram Walkthrough

flowchart LR
  A["liveness_images field"] -- "remove '6-8' from description" --> B["Updated descriptions"]
  C["400 error examples"] -- "remove insufficientLiveness" --> D["Simplified error responses"]
Loading

File Walkthrough

Relevant files
Documentation
1 files
CHANGELOG.md
Add v3.667.0 changelog entry                                                         
+11/-0   
Enhancement
6 files
v3-biometric-authentication-entry.yaml
Remove "6–8" count from liveness_images description           
+1/-1     
v3-biometric-enrollment-entry.yaml
Remove count from description and insufficientLiveness error
+1/-6     
v3-biometric-kyc-entry.yaml
Remove count from description and insufficientLiveness error
+1/-6     
v3-document-verification-entry.yaml
Remove count from description and insufficientLiveness error
+1/-6     
v3-enhanced-document-verification-entry.yaml
Remove count from description and insufficientLiveness error
+1/-6     
v3-smart-selfie-compare-entry.yaml
Remove "6–8" count from liveness_images description           
+1/-1     


Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @prfectionist

    prfectionist Bot commented Jun 15, 2026

    Copy link
    Copy Markdown

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🏅 Score: 90
    🧪 No relevant tests
    🔒 No security concerns identified
    🔀 No multiple PR themes
    ⚡ Recommended focus areas for review

    Inconsistency

    The minItems: 6 and maxItems: 8 constraints are still present in the schema definition, but the insufficientLiveness error example documenting what happens when fewer than 6 images are provided has been removed. This could confuse API consumers who encounter the validation error at runtime but find no documentation about it. Consider whether the server still enforces this constraint and if so, whether removing the error example is appropriate.

    liveness_images:
      type: array
      minItems: 6
      maxItems: 8
      items:
        type: string
        format: binary
      description: >-
        Array of JPEG liveness sequence images captured during the liveness check.

    Comment on lines 178 to +181
    type: string
    format: binary
    description: >-
    Array of 6–8 JPEG liveness images. Required unless use_enrolled_image is true.
    Array of JPEG liveness images. Required unless use_enrolled_image is true.

    Copy link
    Copy Markdown

    Choose a reason for hiding this comment

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

    Suggestion: The description no longer mentions the 6–8 range, but minItems: 6 and maxItems: 8 constraints are still present in the schema. This creates an inconsistency: the description says "Array of JPEG liveness images" (implying flexible count) while the schema still enforces 6–8. Either update the constraints to match the new description or restore the count range in the description. [general, importance: 5]

    New proposed code:
     liveness_images:
       type: array
    -  minItems: 6
    +  minItems: 1
       maxItems: 8
       items:
         type: string
         format: binary
       description: >-
         Array of JPEG liveness images. Required unless use_enrolled_image is true.

    @beastawakens Ed Fricker (beastawakens) merged commit 7f77d00 into main Jun 15, 2026
    2 checks passed
    @beastawakens Ed Fricker (beastawakens) deleted the sync/v3.667.0 branch June 15, 2026 23:24

    Copilot AI left a comment

    Copy link
    Copy Markdown

    Choose a reason for hiding this comment

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

    Pull request overview

    Automated update to the v3 OpenAPI “entry” specs for release v3.667.0, primarily simplifying liveness-related descriptions and pruning a removed 400-response error example, plus recording the update in the changelog.

    Changes:

    • Removed the explicit “6–8” wording from liveness_images descriptions across affected v3 specs.
    • Removed the insufficientLiveness 400-response example blocks where present.
    • Added a v3.667.0 entry to CHANGELOG.md.

    Reviewed changes

    Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

    Show a summary per file
    File Description
    CHANGELOG.md Adds the v3.667.0 changelog entry documenting the spec updates.
    specs/v3/v3-biometric-authentication-entry.yaml Updates liveness_images description to remove the “6–8” wording.
    specs/v3/v3-biometric-enrollment-entry.yaml Removes insufficientLiveness 400 example and removes “6–8” wording from liveness description.
    specs/v3/v3-biometric-kyc-entry.yaml Removes insufficientLiveness 400 example and removes “6–8” wording from liveness description.
    specs/v3/v3-document-verification-entry.yaml Removes insufficientLiveness 400 example and removes “6–8” wording from liveness description.
    specs/v3/v3-enhanced-document-verification-entry.yaml Removes insufficientLiveness 400 example and removes “6–8” wording from liveness description.
    specs/v3/v3-smart-selfie-compare-entry.yaml Updates liveness_images description to remove the “6–8” wording.

    💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants