rpki-validator-3 icon indicating copy to clipboard operation
rpki-validator-3 copied to clipboard

API documentation/specification

Open nusenu opened this issue 7 years ago • 3 comments

It would be great to have parameter level documentation for the API.

https://www.ripe.net/ripe/mail/archives/routing-wg/2018-September/003615.html

nusenu avatar Sep 19 '18 22:09 nusenu

This is important because the old API documentation isn't actually valid: https://www.ripe.net/support/documentation/developer-documentation/rpki-validator-api

devicenull avatar Nov 01 '18 16:11 devicenull

Yes, we need to update the documentation. For the time being, you can check the swagger doc. It's not fully specified, but might help.

https://rpki-validator.ripe.net/swagger-ui.html

This is important because the old API documentation isn't actually valid: https://www.ripe.net/support/documentation/developer-documentation/rpki-validator-api

dacruz avatar Nov 12 '18 10:11 dacruz

dacruz:

Yes, we need to update the documentation. For the time being, you can check the swagger doc. It's not fully specified, but might help.

As can be seen in the routing-wg email linked in the first post of this issue, I opened this issue specifically because the swagger doc does not include enough information.

nusenu avatar Nov 12 '18 10:11 nusenu