RIPE-NCC / rpki-validator-3

RIPE NCC RPKI Validator 3
Other
62 stars 27 forks source link

API documentation/specification #48

Open nusenu opened 5 years ago

nusenu commented 5 years ago

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

devicenull commented 5 years ago

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

dacruz commented 5 years ago

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

nusenu commented 5 years ago

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.