Skip to content

Generating OpenAPI documentation from class failed #7311

@ruwanthalk

Description

@ruwanthalk

Summary

I am trying to generate a OpenAPI spec documentation for my simple classes

@RestResource(urlMapping='/mcp/createCase')
global with sharing class MCPCreateCase {

    global class RequestWrapper {
        global String subject;
        global String description;
        global String priority;
    }

    global class ResponseWrapper {
        global String recordNumber;
        global String message;

        public ResponseWrapper(String recordNumber, String message) {
            this.recordNumber = recordNumber;
            this.message = message;
        }
    }

    @HttpPost
    global static ResponseWrapper execute(RequestWrapper request) {
        Case c = new Case(
            Subject = request.subject,
            Description = request.description,
            Priority = request.priority,
            Origin = 'Web'
        );
        insert c;
        Case newCase = [SELECT CaseNumber FROM Case WHERE Id = :c.Id];
        return new ResponseWrapper(newCase.CaseNumber, 'Success: Case created');
    }
}

I have installed the Apex OpenAPI document extension from SF and when I click "create OpenAPI documentation from this class" it fails as follows

Image

Steps To Reproduce:

  1. Install the extension
  2. Go to the class
  3. right click click "create OpenAPI documentation from this class"

Expected result

Generate the OpenAPI speced documentation

Actual result

Gives the following error

Image

Salesforce Extension Version in VS Code:
Apex OpenAPI document extension

Salesforce CLI Version:
@salesforce/cli/2.133.4 win32-x64 node-v22.22.2

OS and version:
Win 11

VS Code version:

1.1.19.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    waiting for userUse this label when you are waiting for some action to be taken by the user

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions