Fork me on GitHub

Fetch, extract and validate YANG models using REST

The REST API described below allows you to perform the fetch, extract and validate steps provided using HTTP GET.

The URLs below accepts GET requests and return their payload in JSON with the with the Content-Type header set to application/json.

/api/rfc/<rfc>
This URL allows you to fetch, extract and validate YANG modules that are part of currently available IETF RFCs. Replace <rfc> with the number of the RFC, e.g. 7223.
/api/draft/<draft>
This URL allows you to fetch, extract and validate YANG modules that are part of currently published IETF drafts. Replace <draft> with the canonical name of the draft, e.g. draft-ietf-netmod-ip-cfg-14. Remove the version number at the end of the name to retrieve the most recent version published (e.g. draft-ietf-netmod-ip-cfg).

The response JSON consists of a list of objects (one per extracted YANG modules) with the name of the extracted YANG module and the following content:

/api/versions
This URL returns the version strings for all involved components (validation application, xym, pyang and confdc).