Skip to content

Commit

Permalink
Grammar and spelling fixes (#329)
Browse files Browse the repository at this point in the history
  • Loading branch information
scop authored and wing328 committed Jun 16, 2018
1 parent e5635d2 commit 798bf61
Show file tree
Hide file tree
Showing 42 changed files with 70 additions and 70 deletions.
2 changes: 1 addition & 1 deletion bin/utils/ensure-up-to-date
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash
# this bash script run the scripts for the 'mature' generators
# it ensures that all changes are commited into the 'samples/' folder
# it ensures that all changes are committed into the 'samples/' folder

echo "# START SCRIPT: $0"

Expand Down
4 changes: 2 additions & 2 deletions docs/3.0.0-release-note.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ cf8d8d56f [PHP] Fix code example from README. Variable name was missing when usi
76907cacd [PHP] declare property headerSelector

### Python
7184f1ec6 [python] asyncio supports _preload_content; remove unsed imports (#107)
7184f1ec6 [python] asyncio supports _preload_content; remove unused imports (#107)
d74d2ba03 fix: python clients
8e0a0ebd6 Fix python / tornado body handling
b39c35c76 Fix inconsistency between model name and file name in python client
Expand Down Expand Up @@ -250,7 +250,7 @@ ce930e7a6 [Jaxrs-cxf] Add bean-level cascaded beanvalidation for pojos (@Valid)
ff1178ad7 [Java][Spring] fix missing optional query params
2103fadab Fix package declaration for play-framework
2c6380c84 fix inner item (list, map) for play framework
e33b350c8 Fix an issue in Play Framework generator where a CSV is empty and transfered to the controllerImp with an empty item.
e33b350c8 Fix an issue in Play Framework generator where a CSV is empty and transferred to the controllerImp with an empty item.
99fc27246 [JAX-RS][Spec] Removes throws Exception.
fe2a44339 Fixes issue (SpringCodeGen dateLibrary "java8-localdatetime" option is ignored).
d890d733f [JaxRS][Java] issue with implFolder on windows, and required fields generation for containers (#88)
Expand Down
4 changes: 2 additions & 2 deletions modules/openapi-generator-online/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ This is an example of building a OpenAPI-enabled server in Java using the Spring

The underlying library integrating OpenAPI to SpringBoot is [springfox](https://github.com/springfox/springfox)

Start your server as an simple java application
Start your server as a simple java application

Change default port value in application.properties
Change default port value in application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ public Map<String, Object> postProcessAllModels(Map<String, Object> objs) {
for (String name : allModels.keySet()) {
CodegenModel cm = allModels.get(name);
CodegenModel parent = allModels.get(cm.getParent());
// if a discriminator exists on the parent, don't add this child to the inheritance heirarchy
// if a discriminator exists on the parent, don't add this child to the inheritance hierarchy
// TODO Determine what to do if the parent discriminator name == the grandparent discriminator name
while (parent != null) {
if (parent.getChildren() == null) {
Expand Down Expand Up @@ -1201,7 +1201,7 @@ public String getSchemaType(Schema schema) {
*/
private static String getPrimitiveType(Schema schema) {
if (schema == null) {
throw new RuntimeException("schema cannnot be null in getPrimitiveType");
throw new RuntimeException("schema cannot be null in getPrimitiveType");
} else if (ModelUtils.isStringSchema(schema) && "number".equals(schema.getFormat())) {
// special handle of type: string, format: number
return "BigDecimal";
Expand Down Expand Up @@ -1300,7 +1300,7 @@ public String getTypeDeclaration(Schema schema) {

/**
* Determine the type alias for the given type if it exists. This feature
* was original developed for Java because the language does not have a aliasing
* was originally developed for Java because the language does not have an aliasing
* mechanism of its own but later extends to handle other languages
*
* @param name The type name.
Expand Down Expand Up @@ -2055,7 +2055,7 @@ public CodegenOperation fromOperation(String path,
}

if (operation == null)
throw new RuntimeException("operation cannnot be null in fromOperation");
throw new RuntimeException("operation cannot be null in fromOperation");

// store the original operationId for plug-in
op.operationIdOriginal = operation.getOperationId();
Expand Down Expand Up @@ -3853,7 +3853,7 @@ public static Set<String> getConsumesInfo(OpenAPI openAPI, Operation operation)
RequestBody requestBody = ModelUtils.getReferencedRequestBody(openAPI, operation.getRequestBody());

if (requestBody == null || requestBody.getContent() == null || requestBody.getContent().isEmpty()) {
return Collections.emptySet(); // return emtpy set
return Collections.emptySet(); // return empty set
}
return requestBody.getContent().keySet();
}
Expand Down Expand Up @@ -4249,7 +4249,7 @@ public CodegenParameter fromRequestBody(RequestBody body, Map<String, Schema> sc
if (schema.getAdditionalProperties() != null) {// http body is map
LOGGER.error("Map should be supported. Please report to openapi-generator github repo about the issue.");
} else if (codegenProperty != null) {
LOGGER.warn("The folowing schema has undefined (null) baseType. " +
LOGGER.warn("The following schema has undefined (null) baseType. " +
"It could be due to form parameter defined in OpenAPI v2 spec with incorrect consumes. " +
"A correct 'consumes' for form parameters should be " +
"'application/x-www-form-urlencoded' or 'multipart/form-data'");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1012,7 +1012,7 @@ private Map<String, Object> processModels(CodegenConfig config, Map<String, Sche
for (String key : definitions.keySet()) {
Schema schema = definitions.get(key);
if (schema == null)
throw new RuntimeException("schema cannnot be null in processMoels");
throw new RuntimeException("schema cannot be null in processMoels");
CodegenModel cm = config.fromModel(key, schema, allDefinitions);
Map<String, Object> mo = new HashMap<String, Object>();
mo.put("model", cm);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ public void postProcessParameter(CodegenParameter parameter) {
/**
* Post process the media types (produces and consumes) for Ada code generator.
* <p>
* For each media type, add a adaMediaType member that gives the Ada enum constant
* For each media type, add an adaMediaType member that gives the Ada enum constant
* for the corresponding type.
*
* @param types the list of media types.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ private void addMustacheLambdas(Map<String, Object> objs) {
.build();

if (objs.containsKey("lambda")) {
LOGGER.warn("An property named 'lambda' already exists. Mustache lambdas renamed from 'lambda' to '_lambda'. " +
LOGGER.warn("A property named 'lambda' already exists. Mustache lambdas renamed from 'lambda' to '_lambda'. " +
"You'll likely need to use a custom template, " +
"see https://github.com/swagger-api/swagger-codegen#modifying-the-client-library-format. ");
objs.put("_lambda", lambdas);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ private void addMustacheLambdas(Map<String, Object> objs) {
.build();

if (objs.containsKey("lambda")) {
LOGGER.warn("An property named 'lambda' already exists. Mustache lambdas renamed from 'lambda' to '_lambda'. " +
LOGGER.warn("A property named 'lambda' already exists. Mustache lambdas renamed from 'lambda' to '_lambda'. " +
"You'll likely need to use a custom template, " +
"see https://github.com/swagger-api/swagger-codegen#modifying-the-client-library-format. "); // TODO: update the URL
objs.put("_lambda", lambdas);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public static URL getServerURL(OpenAPI openAPI) {
LOGGER.warn("Server information seems not defined in the spec. Default to {}.", LOCAL_HOST);
return getDefaultUrl();
}
// TOOD need a way to obtain all server URLs
// TODO need a way to obtain all server URLs
final Server server = servers.get(0);
String url = sanitizeUrl(server.getUrl());

Expand Down Expand Up @@ -150,4 +150,4 @@ private static URL getDefaultUrl() {
return null;
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ run the following command:
gprbuild -p -P{{projectName}}
```

After the build is successfull, you will get the server binary
After the build is successful, you will get the server binary
in bin/{{packageName}}-server and you can start it as follows:
```
./bin/{{packageName}}-server
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ expanded class
feature -- Access

from_json (a_val:STRING; a_type: TYPE [detachable ANY] ): detachable ANY
-- Deserialize a a json representation `a_val' to an object
-- Deserialize a json representation `a_val' to an object
-- of type `a_type'
local
conv_from: JSON_BASIC_REFLECTOR_DESERIALIZER
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -915,7 +915,7 @@ public class ApiClient {
* @param <T> Type
* @param response Response
* @param returnType Return type
* @throws ApiException If the response has a unsuccessful status code or
* @throws ApiException If the response has an unsuccessful status code or
* fail to deserialize the response body
* @return Type
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is an example of building a OpenAPI-enabled server in Java using the Spring
The underlying library integrating OpenAPI to SpringBoot is [springfox](https://github.com/springfox/springfox)

{{/useSpringfox}}
Start your server as an simple java application
Start your server as a simple java application

{{^reactive}}
You can view the api documentation in swagger-ui by pointing to
Expand Down Expand Up @@ -46,4 +46,4 @@ public interface PetClient extends PetApi {
}
```
{{/interfaceOnly}}
{{/interfaceOnly}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/*
* MultipartFormData.h
*
* This class represents a container for building a application/x-multipart-formdata requests.
* This class represents a container for building application/x-multipart-formdata requests.
*/

#ifndef {{modelHeaderGuardPrefix}}_MultipartFormData_H_
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ defmodule {{moduleName}}.Connection do
{{/isOAuth}}
{{#isBasic}}
@doc """
Configure an client connection using Basic authentication.
Configure a client connection using Basic authentication.

## Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import flash.events.Event;
public class ApiClientEvent extends Event{

/**
* Event type to indicate a unsuccessful invocation
* Event type to indicate an unsuccessful invocation
*/
public static const FAILURE_EVENT:String = "unsuccesfulInvocation";

Expand All @@ -33,4 +33,4 @@ public class ApiClientEvent extends Event{
super(type, bubbles, cancelable);
}
}
}
}
6 changes: 3 additions & 3 deletions modules/openapi-generator/src/main/resources/flash/build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<!-- Flex Ant Tasks used to perform compc and mxml compiling more info at http://labs.adobe.com/wiki/index.php/Flex_Ant_Tasks -->
<taskdef resource="flexTasks.tasks" classpath="${FLEX_HOME}/ant/lib/flexTasks.jar"/>

<target name="setup" description="perform an setup operations"/>
<target name="setup" description="perform setup operations"/>

<!-- Execute the ASDoc Compile which runs 3 separate tasks in a series -->
<target name="compile" description="series of tasks to create docs and swc">
Expand All @@ -28,7 +28,7 @@

</target>

<target name="deploy" description="perform an deployment operations"/>
<target name="deploy" description="perform deployment operations"/>

<target name="install" description="perform an installation operations"/>

Expand Down Expand Up @@ -189,4 +189,4 @@
<target name="test" depends="compile-test, do-test">
</target>

</project>
</project>
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def _deserialize_primitive(data, klass):


def _deserialize_object(value):
"""Return a original value.
"""Return an original value.

:return: object.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ func (c contextKey) String() string {
}

var (
// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOAuth2 = contextKey("token")

// ContextBasicAuth takes BasicAuth as authentication for the request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ g)Allow you to integrate with tracing server (Example Zipkin)
h)Allow you to capture log in your microservice and send to Log management server (Ex ELK or splunk)
i)Allow you to configure Oauth2 security based authorization for your microservice

Additonal Features
Additional Features
j)generate sample cucumber file and dependency to drive your Behaviour driven development.
k)generate gatling based perfromance test , which can be excuted via build pipeline like jenkins etc.
k)generate gatling based performance test, which can be excuted via build pipeline like jenkins etc.


Working:
Expand Down Expand Up @@ -136,7 +136,7 @@ HttpLogging filter is provided for logging in the request and response. Can be f
Spring security is also provided to secure the resources. Please modify according to your needs.

First run:
Import the project in to the eclipse. Run the app as an spring boot application.The project will run on http://localhost:8008
Import the project in to the eclipse. Run the app as a spring boot application.The project will run on http://localhost:8008
Swagger ui available on:
http://localhost:8008/swagger-ui.html
If all the configurations have been enabled(depending on the port) below are some of the URls to access:
Expand All @@ -152,4 +152,4 @@ Pkmst examples
https://github.com/ProKarma-Inc/pkmst-getting-started-examples

Pkmst Extensions
https://github.com/ProKarma-Inc/pkmst-extention
https://github.com/ProKarma-Inc/pkmst-extention
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
/**
* Sets API key
*
* To remove a apiKey for an identifier, just set the apiKey to nil.
* To remove an apiKey for an identifier, just set the apiKey to nil.
*
* @param apiKey API key or token.
* @param identifier API key identifier (authentication schema).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ extern NSInteger const {{classPrefix}}UnknownResponseObjectErrorCode;
@interface {{classPrefix}}ResponseDeserializer : NSObject <{{classPrefix}}ResponseDeserializer>

/**
* If an null value occurs in dictionary or array if set to YES whole response will be invalid else will be ignored
* If a null value occurs in dictionary or array if set to YES whole response will be invalid else will be ignored
* @default NO
*/
@property (nonatomic, assign) BOOL treatNullAsError;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ class ObjectSerializer
* @param string[] $httpHeaders HTTP headers
* @param string $discriminator discriminator if polymorphism is used
*
* @return object|array|null an single or an array of $class instances
* @return object|array|null a single or an array of $class instances
*/
public static function deserialize($data, $class, $httpHeaders = null)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ class ApiClient(object):
return data

def __deserialize_object(self, value):
"""Return a original value.
"""Return an original value.

:return: object.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ PROJECT_NUMBER = {{#openAPI}}{{#info}}{{version}}{{/info}}{{/openAPI}}

PROJECT_BRIEF = "An SDK for creating client applications for {{#openAPI}}{{#info}}{{title}}{{/info}}{{/openAPI}} on Tizen Platform (http://tizen.org/)"

# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# With the PROJECT_LOGO tag one can specify a logo or icon that is included in
# the documentation. The maximum height of the logo should not exceed 55 pixels
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ It can be used in both TypeScript and JavaScript. In TypeScript, the definition

### Building

To build an compile the typescript sources to javascript use:
To build and compile the typescript sources to javascript use:
```
npm install
npm run build
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Building

To build an compile the typescript sources to javascript use:
To build and compile the typescript sources to javascript use:
```
npm install
npm run build
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ It can be used in both TypeScript and JavaScript. In TypeScript, the definition

### Building

To build an compile the typescript sources to javascript use:
To build and compile the typescript sources to javascript use:
```
npm install
npm run build
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ public void arrayModelTest() {
Assert.assertEquals(Sets.intersection(cm.imports, Sets.newHashSet("Children")).size(), 1);
}

@Test(description = "convert an map model")
@Test(description = "convert a map model")
public void mapModelTest() {
final Schema schema = new Schema()
.description("a map model")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ public void arrayModelTest() {
Assert.assertEquals(cm.imports.size(), 1);
}

@Test(description = "convert an map model")
@Test(description = "convert a map model")
public void mapModelTest() {
final Schema model = new Schema()
.additionalProperties(new Schema().$ref("#/definitions/Children"))
Expand Down
Loading

0 comments on commit 798bf61

Please sign in to comment.