Update API specifications with fern api update

[wintonzheng]

Update API specifications by running fern api update.

---

🔧 This PR updates the API specifications by running fern api update, adding new TOTP authentication fields and XPath support to enhance the OpenAPI schema with better 2FA handling and element targeting capabilities.

🔍 Detailed Analysis

Key Changes

• TOTP Authentication: Added totp_type field to credential schemas with enum values (authenticator, email, text, none) for supporting different 2FA methods
• XPath Support: Introduced optional xpath field (string or null) to tool call specifications for better element targeting
• Schema Definitions: Added new TotpType enum schema definition with comprehensive 2FA method options

Technical Implementation

flowchart TD
    A[API Schema Update] --> B[TOTP Type Addition]
    A --> C[XPath Field Addition]
    B --> D[Credential Schemas Enhanced]
    B --> E[New TotpType Enum]
    C --> F[Tool Call Schema Updated]
    D --> G[Better 2FA Support]
    E --> H[Standardized Auth Types]
    F --> I[Improved Element Targeting]

Loading

Impact

• Authentication Enhancement: Provides structured support for various 2FA methods including authenticator apps, email, and SMS verification
• Element Targeting: XPath field addition enables more precise web element identification and interaction
• API Consistency: Automated schema updates ensure the OpenAPI specification stays synchronized with the codebase
• Backward Compatibility: All new fields are optional or have default values, maintaining compatibility with existing implementations

Created with Palmier

---

Important

Update skyvern_openapi.json to include new xpath and totp_type properties and TotpType schema.

• API Specification Updates:
  • Add xpath property to skyvern_openapi.json with string or null type.
  • Add totp_type property to skyvern_openapi.json with reference to TotpType schema, default none, and example authenticator.
  • Add TotpType schema to skyvern_openapi.json with enum values: authenticator, email, text, none.

^{This description was created by for 390acfb. You can customize this summary. It will automatically update as commits are pushed.}

Summary by CodeRabbit

• New Features
  • Introduced a configurable two‑factor method type for credentials (authenticator, email, text, none), now included in relevant credential inputs and responses.
  • Added an optional xpath field to actions to enable more precise element targeting.

[ellipsis-dev]

Caution

Changes requested ❌

Reviewed everything up to 390acfb in 2 minutes and 4 seconds. Click for details.

• Reviewed 70 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 4 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. fern/openapi/skyvern_openapi.json:2533

• Draft comment:
  For the 'xpath' field, consider using OpenAPI's 'nullable: true' with type 'string' instead of an 'anyOf' for nullability. This may simplify the schema.
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50% None

2. fern/openapi/skyvern_openapi.json:8330

• Draft comment:
  Ensure the 'totp_type' field's default value 'none' is correct and aligns with backend logic for this credential schema.
• Reason this comment was not posted:
  Confidence changes required: 30% <= threshold 50% None

3. fern/openapi/skyvern_openapi.json:8676

• Draft comment:
  The 'totp_type' field is added consistently here. Confirm that its default and example values match expectations across schemas.
• Reason this comment was not posted:
  Confidence changes required: 30% <= threshold 50% None

4. fern/openapi/skyvern_openapi.json:10954

• Draft comment:
  The TotpType enum definition appears correct. Verify that the enumerated values ('authenticator', 'email', 'text', 'none') fully cover the allowed 2FA methods.
• Reason this comment was not posted:
  Confidence changes required: 30% <= threshold 50% None

Workflow ID: wflow_DbmVUMfMEwucVbOH

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

[ellipsis-dev]

Typo: Consider capitalizing 'Xpath' to 'XPath' if that is the intended terminology.

Suggested change

	"title": "Xpath"
	"title": "XPath"

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Introduces a new TotpType enum in the OpenAPI spec and adds fields referencing it. Extends Action with an optional xpath field. Adds totp_type to NonEmptyPasswordCredential and PasswordCredentialResponse. All changes are within fern/openapi/skyvern_openapi.json.

Changes

Cohort / File(s)	Summary of changes
OpenAPI schema updates fern/openapi/skyvern_openapi.json	Added TotpType enum (authenticator, email, text, none). Extended Action with optional string/null field xpath. Added totp_type (TotpType) to NonEmptyPasswordCredential and PasswordCredentialResponse.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Update API specifications with fern api update #3651 — Also modifies the Action schema (adds totp_timing_info), overlapping with this PR’s Action schema update.

Suggested reviewers

• suchintan

Poem

Hopper of keys and paths I tread,
Enum carrots neatly spread.
Xpaths sprout where actions roam,
TOTP types find their home.
Credentials hum a safer tune—
Hop, merge soon, beneath the moon. 🥕🌙

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The current title is generic and focuses on the tooling (“fern api update”) rather than the substantive API changes such as adding the TotpType enum and new fields, so it does not clearly convey the main purpose of the changeset. It lacks specificity about the schema extensions and new enum introduced.	Consider revising the title to summarize the core API modifications, for example: “Add TotpType enum and totp_type fields to OpenAPI schema” or “Extend API spec with TotpType enum, totp_type, and xpath fields.”

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-openapi-spec-2025-10-13T00-32-32-484Z

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a8179ae and 390acfb.

📒 Files selected for processing (1)

• fern/openapi/skyvern_openapi.json (4 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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