Skip to content

Add a rake task to generate a markdown doc for a grape endpoint

Kassio Borges requested to merge kassio/grape-routes-with-parameters into master

What does this MR do?

This proposed rake task aims to help Gitlab contributors to write Grape API documentation faster by using the code documentation to generate part of the documentation markdown.

Screenshots or Screencasts (strongly suggested)

$ bin/rails "grape:routes:to_doc[bulk_imports/entities]"

Output >

List all GitLab Migrations' entities

GET /api/:version/bulk_imports/entities(.:format)
Attribute Type Required Description
page Integer no Current page number
per_page Integer no Number of items per page
status String no Return all GitLab Migrations' entities with specified status

< Output

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Kassio Borges

Merge request reports

Loading