documentation-developer icon indicating copy to clipboard operation
documentation-developer copied to clipboard

IBX-6107: REST API ref tester

Open adriendupuis opened this issue 2 years ago • 1 comments

Question Answer
JIRA Ticket IBX-6107, IBX-1430
Versions N/A
Edition N/A

Compares the REST API reference to DXP config.

This tool helps to find missing REST routes, missing REST route methods and non-existent REST routes. It extracts reference routes from the HTML output of the raml2html build. It extracts configuration routes from the yaml files of the DXP. It compares routes existng only on one side and it compares methods of common routes. When a route doesn't exists on one side, it tries few argument renamings (like Id↔︎Identifier) or if the route if flagged (removed) (see #1642 for the unification of depreciation and removal flags).

Checklist

  • [ ] Text renders correctly
  • [ ] Text has been checked with vale
  • [ ] Description metadata is up to date
  • [ ] Redirects cover removed/moved pages
  • [ ] Code samples are working
  • [ ] PHP code samples have been fixed with PHP CS fixer
  • [ ] Added link to this PR in relevant JIRA ticket or code PR

adriendupuis avatar Feb 17 '23 08:02 adriendupuis

Splitted from #1642 See https://github.com/ezsystems/developer-documentation/pull/1642#discussion_r1108581459 for an early comment.

adriendupuis avatar Feb 17 '23 09:02 adriendupuis