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

Commit c156e79

Browse files
committed
Correcting the name of Open API Tools (VS Code)
Remove any reference to Codewind API Tools from the docs. The correct name is "Open API Tools for Eclipse Codewind."
1 parent 7a9cde6 commit c156e79

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/_documentations/codewind-openapi-vscode.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
layout: docs
3-
title: Codewind OpenAPI Tools for VS Code
4-
description: How to work with the OpenAPI tools in VS Code
5-
keywords: install, run, open, import, show, restart, edit, build, logs, tools, eclipse, Codewind OpenAPI tools for VS Code
3+
title: Open API Tools for Eclipse Codewind in VS Code
4+
description: How to work with the Open API Tools for Eclipse Codewind in VS Code
5+
keywords: install, run, open, import, show, restart, edit, build, logs, tools, eclipse, Open API Tools for Eclipse Codewind in VS Code
66
duration: 1 minute
77
permalink: open-api-tools-for-vscode.html
88
type: document
99
order: 30
1010
---
1111

12-
# Codewind OpenAPI Tools for VS Code
12+
# Open API Tools for Eclipse Codewind in VS Code
1313

14-
The Codewind OpenAPI Tools for VS Code provides commands that invoke the OpenAPI Generator to create API clients, server stubs, and HTML documentation from OpenAPI definitions. The tools are integrated and customized to work with Codewind for VS Code, but they can also work without the Codewind extension.
14+
The Open API Tools for Eclipse Codewind in VS Code provides commands that invoke the OpenAPI Generator to create API clients, server stubs, and HTML documentation from OpenAPI definitions. The tools are integrated and customized to work with Codewind for VS Code, but they can also work without the Codewind extension.
1515

1616
## Prerequisites
1717
- Install Docker before you run the generator. In VS Code, the plug-in pulls in the OpenAPI generator image from [Docker](https://github.com/OpenAPITools/openapi-generator#16---docker).
@@ -20,9 +20,9 @@ The Codewind OpenAPI Tools for VS Code provides commands that invoke the OpenAPI
2020
1. Install [VS Code version 1.27 or later](https://code.visualstudio.com/download).
2121
2. (OPTIONAL) Install Codewind for VS Code from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.codewind) or by searching for `Codewind` in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
2222
3. This extension pulls the [OpenAPI Generator CLI Docker Image](https://github.com/OpenAPITools/openapi-generator#16---docker) and runs the OpenAPI Generator in a Docker container. Install Docker if necessary.
23-
4. Install the Codewind OpenAPI Tools from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-openapi-tools) or by searching for `Codewind OpenAPI` in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
23+
4. Install the Open API Tools for Eclipse Codewind from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-openapi-tools) or by searching for `Codewind OpenAPI` in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
2424

25-
## Generating and building client and server stubs by using the OpenAPI tools
25+
## Generating and building client and server stubs by using the Open API Tools for Eclipse Codewind
2626
1. Right-click your Codewind project from the Codewind view and select either the **Generate Server from OpenAPI Definition** menu or **Generate Client from OpenAPI Definition** action. You are then prompted to provide options to the OpenAPI generator.
2727
2. Select your OpenAPI document file. The file must be a valid OpenAPI 3.0 `.yaml` or `.json` file that is in the project.
2828
3. Select the client or server generator type.
@@ -33,7 +33,7 @@ The Codewind OpenAPI Tools for VS Code provides commands that invoke the OpenAPI
3333
8. Now, you can customize the application logic. Choose one of the two methods in the **Generating and building code in an existing Java Spring project** section.
3434

3535
## Generating and building code in an existing Java Spring project
36-
When you generate a Spring server stub into a Spring project, the OpenAPI tools for VS Code don't override the main class that is already implicitly or explicitly configured in the project. Complete one of the following steps to expose the OpenAPI endpoints:
36+
When you generate a Spring server stub into a Spring project, the Open API Tools for Eclipse Codewind in VS Code don't override the main class that is already implicitly or explicitly configured in the project. Complete one of the following steps to expose the OpenAPI endpoints:
3737
- To use the generated class, uncomment the main method in the `OpenAPI2SpringBoot.java` Java class file and explicitly configure the project to use this main class.
3838
- To continue to use the currently configured main class, copy the base packages that are listed in the `@ComponentScan` component scan annotation from the `OpenAPI2SpringBoot.java` file. Then, add the packages to the currently configured main class. For example, if you use the Codewind Spring Boot project, the implicit main class is the `SBApplication.java` file.
3939

@@ -59,4 +59,4 @@ The following command line equivalent options are available for HTML generation:
5959
## Features
6060
- Generate API clients in any of the supported [languages/frameworks](https://github.com/OpenAPITools/openapi-generator#overview).
6161
- Generate server stubs in any of the supported [languages/frameworks](https://github.com/OpenAPITools/openapi-generator#overview).
62-
- Generate HTML documentation from an OpenAPI definition file.
62+
- Generate HTML documentation from an OpenAPI definition file.

0 commit comments

Comments
 (0)