OpenAPITools / OpenAPITools/openapi-generator

[BUG] Documentation for online hosted generator is missing

Open
#10,397 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

The documentation for the online hosted generator here:
https://github.com/OpenAPITools/openapi-generator/blob/master/docs/online.md
simply provides a link to the hosted generator web page. There is no documentation on how to use it.

Also, there is a button "LOCAL JSON FILE" but it doesn't appear to do anything.

openapi-generator version

5.2.1 http://api.openapi-generator.tech/index.html

OpenAPI declaration file content or url
Generation Details
Steps to reproduce

Go to http://api.openapi-generator.tech/index.html and try to generate a client from an uploaded JSON file, without any instructions

Related issues/PRs
Suggest a fix

Take some time to complete the codumentation on how to use the online hosted tool.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading docs/online.md and opening the hosted generator at api.openapi-generator.tech/index.html. Document the steps for generating a client from an uploaded JSON file, including the purpose and behavior of the “LOCAL JSON FILE” button. The work is done when a newcomer can use the hosted tool without needing to infer the workflow.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.