Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation should flow to Javadoc #5511

Open
brendon- opened this issue Dec 31, 2024 · 0 comments
Open

documentation should flow to Javadoc #5511

brendon- opened this issue Dec 31, 2024 · 0 comments

Comments

@brendon-
Copy link

Issue Description

documentation in the fern api definition is lost in the java generated code. no comments are provided.

desired: api documentation, including relevant components and context in addiction to docs string, such as display-name, examples, etc. This should be a markdown formatted javadoc object ///

Additional Context (Optional)

example generated controller route:

  base-path: '/v1/knowledge'
  endpoints:
    create_or_update_knowledge_base:
      display-name: Create or update knowledge base
      docs: Update a knowledge base or create it if it doesn't exist.
      method: PUT
      path: ''
     examples: ....

and generated code:

import org.springframework.web.bind.annotation.RequestMapping;

@RequestMapping(
    path = "/v1/knowledge"
)
public interface KnowledgeService {
  @PutMapping(
      value = "",
      produces = "application/json",
      consumes = "application/json"
  )
  KnowledgeBaseResponse createOrUpdateKnowledgeBase(
      @RequestHeader("X-Organization-Id") String organizationId,
      @RequestHeader("X-Agent-Id") String agentId, @RequestBody KnowledgeBaseRequest body) throws
      NotFoundError, BadRequestError, ServerError;
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant