Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ It is not required but highly suggested that you create unit tests for the code

### Tips
- Smaller changes are easier to review
- [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
- [Optional] For bug fixes, provide an OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
- Add test case(s) to cover the change
- Make sure test cases passed after the change. All tests run after a PR is created or modified.
- File a PR with meaningful title, description and commit messages.
- File a PR with a meaningful title, description and commit messages.
- To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. `fix #1542`. (Ref: [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ The options file is described in json (example in `specs/options.json`), and has
|schemaNamingConvention|string| `CamelCase`, `PascalCase`, `HyphenUpperCase`, `HyphenCase`, `UnderscoreCase`, `UnderscoreUpperCase`, `AnyCase` |`PascalCase`|Naming convention for schemas|
|propertyNamingConvention|string| `CamelCase`, `PascalCase`, `HyphenUpperCase`, `HyphenCase`, `UnderscoreCase`, `UnderscoreUpperCase`, `AnyCase` |`CamelCase`|Naming convention for properties|
|enumNamingConvention|string| `CamelCase`, `PascalCase`, `HyphenUpperCase`, `HyphenCase`, `UnderscoreCase`, `UnderscoreUpperCase`, `AnyCase` |`AnyCase`|Naming convention for enums|
|allowedModelProperties|array| `["_links", "_embedded"]`|`[]`|An array of property names that are authorised even if they do not match to the "propertyNamingConvention"|
|allowedModelProperties|array| `["_links", "_embedded"]`|`[]`|An array of property names that are authorized even if they do not match to the "propertyNamingConvention"|

#### Parameter Naming Convention hierarchy

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ void printHelp(final Options options, final String cmdLineSyntax) {
options,
HelpFormatter.DEFAULT_LEFT_PAD,
HelpFormatter.DEFAULT_DESC_PAD,
"Thanks for using OpenAPI Style Validator! If you this project useful, consider buying us a tree here: https://ecologi.com/darkjaff",
"Thanks for using OpenAPI Style Validator! If you find this project useful, consider buying us a tree here: https://ecologi.com/darkjaff",
true);

printWriter.flush();
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ It is not required but highly suggested that you create unit tests for the code

### Tips
- Smaller changes are easier to review
- [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
- [Optional] For bug fixes, provide an OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
- Add test case(s) to cover the change
- Make sure test cases passed after the change. All tests run after a PR is created or modified.
- File a PR with meaningful title, description and commit messages.
- File a PR with a meaningful title, description and commit messages.
- To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. `fix #1542`. (Ref: [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "FAQ: General"

## Do you have a chat room?

[![Jion the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM)
[![Join the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM)

## What is the governance structure of the OpenAPI Style Validator project?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class OpenAPIStyleValidatorTask extends DefaultTask {

public OpenAPIStyleValidatorTask() {
this.setGroup("Verification");
this.setDescription("Validate that OpenAPI files against style rules");
this.setDescription("Validate OpenAPI files against style rules");
}

@TaskAction
Expand Down
2 changes: 1 addition & 1 deletion website/src/pages/team.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import styles from './styles.module.css';

// This is based mostly off of Babel's website configuration for Members/orgs/etc.
// This is based mostly on Babel's website configuration for Members/orgs/etc.
function MediaLink(props) {
if (props.text) {
return (
Expand Down
2 changes: 1 addition & 1 deletion website/src/pages/users.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ function Users() {
const {users = {}} = siteConfig.customFields;

let showcase = users.map((user, idx) => {
// avoid joining base/ with /img/path as double-slash breaks image load.
// Avoid joining base/ with /img/path as a double-slash breaks image load.
let trimmedImg = user.image.startsWith("/") ? user.image.slice(1, user.image.length) : user.image;
let imgUrl = useBaseUrl(trimmedImg);
return (
Expand Down
Loading