Skip to content

ProgrammersIT/opendelivery-api-schema-validator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 

Repository files navigation


Logo

Open Delivery Schema Validator

A tool to help you be fully compliant with the Open Delivery standard.
Try it out!»

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Usage
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project

Product Name Screen Shot

Open Delivery Schema Validator is a tool that was created to help developers who are creating or adapting their system's APIs to the Open Delivery standard.

With this tool it is possible to validate that a JSON is following the Open Delivery schema routes according to the project's documentation.

Currently the tool can validate:

  • Required fields
  • Field types
  • Field formats (such as date-time)
  • Enumerators

Available routes:

  • GET /v1/merchant/
  • GET /vi/orders/{orderId}/

(back to top)

Built With

  • React
  • Angular
  • TypeScript

(back to top)

Usage

Click here to access the tool.

1 - Select the route you wish to validate;

image

2 - Select whether you want to validate the request or the response schema of the chosen route;

image

3 - Paste the JSON you want to validate and click validate.

image

(back to top)

Roadmap

  • Add Changelog
  • Add the remaining Merchant routes
  • Add the remaining Order routes
  • Add Logistics routes
  • Add Financial Reconcilliation routes
  • Add Contracts routes

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

TBD

(back to top)

Contact

Programmer's Beyond IT - Linkedin | Instagram

Project Link: https://github.com/ProgrammersIT/opendelivery-api-schema-validator

(back to top)