Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use openapi generate from node #21

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
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: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ composer.lock

# OS X
**/.DS_Store

node_modules/

test/
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,24 @@ _Note_: The Content Provider APIs are currently only available in the US.

Thanks for making it all the way down here! We welcome your contributions...the open-source world runs on people like you.

## Building

To set up the build environment, make sure you have Composer, Java 15 or earlier and node.js installed.
Then run `composer install` to install the PHP dependencies, and `npm install` to install the
JavaScript dependencies.

There are a number of scripts in the `package.json` file that you can use to lint, test, and build the package, which can be run using `composer run <script-name>`. The most important ones are:

* `download-schemas`: Fetch the schema files from Walmart's API documentation
* `customize-schemas`: Apply customizations to the schemas
* `generate`: Generate the API classes
* `refresh-schemas`: Download and customise the schemas
* `make`: Download, customise, and generate the schemas
* `version-update`: Generate only the supporting files
* `clean`: Delete generated files
* `lint`: Run all linters


## Pull requests

Please ask (via an issue) before submitting a pull request for any significant feature work. It sucks to put a lot of effort into something only to have it rejected for reasons other than the quality of your code. (_Author's note: don't ask me how I know._) That said, we're open to contributions from anyone, and we'll do our best to get your code merged. Please be patient – we're not ignoring you, but it might take us some time to get to your PR.
Expand Down
7 changes: 7 additions & 0 deletions openapitools.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
"spaces": 2,
"generator-cli": {
"version": "6.6.0"
}
}
Loading