README.md

Convert Procore API Docs to OpenAPI

This project implements a tool to convert JSON from the Procore REST API Documentation to OpenAPI suitable for generating API clients.

This project is unofficial. It is not affiliated with Procore Technologies, Inc.

Introductory Example

fetch-procore-api-docs && procore-docs-to-openapi *.json

Installation

This package can be installed using npm, either globally or locally, by running:

npm install @kevinoid/procore-docs-to-openapi

API Docs

To use this module as a library, see the API Documentation.

Contributing

Contributions are appreciated. Contributors agree to abide by the Contributor Covenant Code of Conduct. If this is your first time contributing to a Free and Open Source Software project, consider reading How to Contribute to Open Source in the Open Source Guides.

If the desired change is large, complex, backwards-incompatible, can have significantly differing implementations, or may not be in scope for this project, opening an issue before writing the code can avoid frustration and save a lot of time and effort.

License

This project is available under the terms of the MIT License. See the summary at TLDRLegal.