Skip to content
This repository was archived by the owner on Nov 28, 2022. It is now read-only.

Commit ec5eb5d

Browse files
sishidasghung
authored andcommitted
Adding section about OpenAPI generation (#80)
* Adding section about OpenAPI generation Signed-off-by: Sarah Ishida <sishida@us.ibm.com> * Updates based on feedback Signed-off-by: Sarah Ishida <sishida@us.ibm.com> * Adding edits from feedback Signed-off-by: Sarah Ishida <sishida@us.ibm.com>
1 parent 905ccd4 commit ec5eb5d

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

docs/_documentations/troubleshooting.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The following sections contain workarounds for issues that you might encounter w
2323
* [Editing your project](#editing-your-project)
2424
* [Disabling development on specific projects](#disabling-development-on-specific-projects)
2525
* [Appsody with Codewind](#appsody-with-codewind)
26+
* [OpenAPI tools](#openapi-tools)
2627

2728
<!-- Provide an upfront link to where users can go if they can't figure out how to troubleshoot the problems. Avoid telling them to call IBM support, but you can link to the support website. -->
2829

@@ -312,4 +313,29 @@ These steps reproduce the issue:
312313
1. Set up a project extension environment and create a Microprofile project.
313314
2. Restart the project in debug mode. You receive one or both of the following error messages: `Failed to attach to remote debuggee VM` or `Failed to attach debugger to at ipaddress:`.
314315

315-
**Workaround** Run the `Attach Debugger` action manually.
316+
**Workaround** Run the `Attach Debugger` action manually.
317+
318+
***
319+
# OpenAPI tools
320+
321+
<!--
322+
Action/Topic: OpenAPI tools
323+
Issue type: bug/info
324+
Issue link: https://github.com/eclipse/codewind/issues/275
325+
Version: 2019-06 (4.12.0)
326+
Build ID: 20190614-1200
327+
-->
328+
## OpenAPI generation fails in Eclipse if the output path does not exist
329+
In Eclipse, OpenAPI generation fails if a path does not exist, and the wizard doesn't automatically create the folder tree hierarchy if the hierarchy doesn't already exist.
330+
331+
These steps reproduce the issue:
332+
1. Install the latest version of Codewind.
333+
2. Add a sample OpenAPI `.yaml` file.
334+
3. From the Project or Package Explorer views, right-click the project and select one of the generator actions in **OpenAPI Generate**. A dialog window appears.
335+
4. In the dialog window, if necessary, select the OpenAPI definition file by clicking the **Browse...** button.
336+
5. In the **Output folder** field, copy and paste a path or edit the path directly.
337+
6. Click **Finish**. The OpenAPI generator fails if the folder doesn't already exist.
338+
339+
**Workaround:** Manually create the output folder before you start the OpenAPI generator wizard. After you create the folder, you can start the wizard again.
340+
341+
For post-client or post-server stub generation, use a separate output folder for code generation. Depending on the language and the generator type, the OpenAPI generator generates both source code files and build-related files. Some refactoring might be necessary. For example, if you are working with an existing Java or Maven project, move the generated source code to the proper source folder that already exists in the project. However, if your project is empty, the target output folder can be the root of the project, and you don't need to do as much refactoring and merging.

0 commit comments

Comments
 (0)