How to document the cnd HTTP API? #1122

thomaseizinger · 2019-07-22T06:06:41Z

Answer the following questions:

Which API-contracts approach should we use? (Originally taken from Ensure non-regression of cnd REST API #1221)
How would a developer validate its API usage against these contracts? (Originally taken from Ensure non-regression of cnd REST API #1221)
How to ensure the documentation and the implementation is not out of sync? Meaning examples actually work against the API (could be checked during e2e tests)
How to generate the documentation (HTML files)?
What does the documentation include?
How to host documentation for current master HEAD?
How to document extension link relation types (Links should use extension relation type #843)?

The text was updated successfully, but these errors were encountered:

thomaseizinger added the ⚗️ spike A time-boxed investigation with the primary goal of gaining knowledge label Jul 22, 2019

thomaseizinger mentioned this issue Jul 23, 2019

Service health HTTP call #522

Closed

thomaseizinger mentioned this issue Aug 19, 2019

Ensure non-regression of cnd REST API #1221

Closed

thomaseizinger added this to the Sprint 20 🍕️🍻️ milestone Aug 21, 2019

luckysori self-assigned this Aug 27, 2019

luckysori mentioned this issue Aug 29, 2019

How to document cnd's HTTP API comit-network/spikes#38

Merged

luckysori closed this as completed in comit-network/spikes#38 Sep 3, 2019

Provide feedback