request-yo-racks / api

A REST API for the Request-Yo-Racks projects.

https://api.requestyoracks.org

MIT License

0 stars 4 forks source link

Design RYR OpenAPI 1.0.0 #59

Closed rgreinho closed 5 years ago

rgreinho commented 6 years ago

Types of changes

Code cleanup / Refactoring
Documentation

Description

This is an attempt to define the current API using the OpenAPI 3.0.1 specification.

Motivation and Context

Using modern tools to generate server stubs and documentation from one well defined document.

How Has This Been Tested?

Checklist:

[X] I have updated the documentation accordingly
[] I have written unit tests

Fixes request-yo-racks/api#57

codecov-io commented 5 years ago

Codecov Report

Merging #59 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #59   +/-   ##
=======================================
  Coverage   98.34%   98.34%           
=======================================
  Files           6        6           
  Lines         241      241           
=======================================
  Hits          237      237           
  Misses          4        4

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 72bf673...9a310db. Read the comment docs.