Failed to create OpenAPI Document: Failed to validate eligibility.

[infallibletechie]

Summary

SFDX: Create OpenAPI Document from this Class (Beta) is not working

Steps To Reproduce:

1. Create an Apex Class.
2. Use SFDX: Create OpenAPI Document from this Class (Beta) command

Expected result

OpenAPI Document files should be generated

Actual result

Failed to create OpenAPI Document: Failed to validate eligibility.

[svc-idee-bot]

Thank you for filing this issue. We appreciate your feedback and will review the issue as soon as possible. Remember, however, that GitHub isn't a mechanism for receiving support under any agreement or SLA. If you require immediate assistance, contact Salesforce Customer Support.

[svc-idee-bot]

Hello @infallibletechie 👋 It looks like you didn't provide all the required basic info in your issue.

If you haven't already, please provide the following info:
Salesforce Extension Version in VS Code:
Salesforce CLI Version:
OS and version:
VS Code version:
Most recent version of the extensions where this was working:

Here's an example of a set of required info that will pass the validation:
Salesforce Extension Version in VS Code: 60.13.0
Salesforce CLI Version: @salesforce/cli/2.42.6 darwin-arm64 node-v18.18.2
OS and version: MacOS Sonoma 14.5
VS Code version: 1.89.1
Most recent version of the extensions where this was working: 60.11.0

A few more things to check:

• Make sure you've provided detailed steps to reproduce your issue, as well as all error messages that you see.
  • A repository that clearly demonstrates the bug is ideal.
  • Error messages can be found in the Problems Tab, Output Tab, and from running Developer: Toggle Developer Tools in the command palette.
• Make sure you've installed the latest version of the Salesforce Extension Pack for VSCode. (docs)
• Search GitHub for existing related issues.

Thank you!

[daphne-sfdc]

Hi @infallibletechie, I assume you created the Apex class using SFDX: Create Apex Class and then tried to generate the OpenAPI document from the class created from the default template, correct? If yes, the error that you're seeing is the expected behavior. We only support generating OpenAPI documents for Apex REST classes, which are annotated with @RestResource. Please refer to the official documentation here: https://developer.salesforce.com/docs/einstein/genai/guide/agent-apex.html

[infallibletechie]

I used Apex REST only.

@RestResource( urlMapping='/CaseApexAPI/v1/Cases/*' )
global without sharing class CaseRESTAPIController {

@HttpPost
global static String importCase(
    String subject, 
    String description
) {

    System.debug( '### importCase ###' );
    System.debug( 'subject: ' + subject );
    System.debug( 'description: ' + description );
    
    Case objCase = new Case(
        Status= 'New',
        Origin= 'Web',
        Priority= 'Low',
        Subject = subject,
        Description = description
    );

    try {

        insert objCase;
        return 'Case created for you!!!';
        
    } catch ( DMLException e ) {

        return e.getMessage();
        
    }
    
}

}

It works in one laptop and not from another laptop.

[daphne-sfdc]

It's working on my computer for your Apex class. Can you provide these specs from the laptop where you're seeing it not working?

Salesforce Extension Version in VS Code:
Salesforce CLI Version:
OS and version:
VS Code version:

[infallibletechie]

VS Code:
Version: 1.98.2
Commit: ddc367ed5c8936efe395cffeec279b04ffd7db78
Date: 2025-03-12T13:32:45.399Z
Electron: 34.2.0
ElectronBuildId: 11161602
Chromium: 132.0.6834.196
Node.js: 20.18.2
V8: 13.2.152.36-electron.0
OS: Darwin arm64 24.3.0

CLI:
@salesforce/cli/2.79.4 darwin-arm64 node-v22.13.1

OS:
MacOS

ÇIdentifier
salesforce.salesforcedx-vscode
Version
63.4.1
Last Updated
2025-03-18, 08:46:05

[daphne-sfdc]

It looks like all the versions you have provided are good. Let's check one more thing - what version of the Agentforce for Developers extension are you using?

I know I see that error when I try to generate an OpenAPI document immediately after opening an Apex class, before the Apex Language Server has completed its indexing of that file. Can I assume that you have retried the generation multiple times and keep on getting the error?