Uploaded image for project: 'MongoDB Shell'
  1. MongoDB Shell
  2. MONGOSH-699

Autogenerate shell-api documentation and other relevant metadata from shell-api source

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Open
    • Priority: Major - P3
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Shell API
    • Labels:
      None
    • Story Points:
      8

      Description

      Currently we do a lot of manual work to maintain shell-api documentation and shell public api input validation when changes are introduced to shell-api.

      Documentation is stored away form source and that creates a lot of churn to maintain, on top of that the documentation format is very basic, not easily allowing for custom things like formatting, links, code snippets etc. without changing the documentation json schema.

      Validation is manually added for methods with limited runtime API. Even though for every API method we specify type information for the input, there is currently no way to get to this info in runtime.

      It would be nice if we could solve both of those issues by automatically extracting shell api metadata from the source code. This might allow us to keep better track of keeping documentation always up to date, provide better output for the help commands, and allow for better, more verbose API calls validation (which means a better understandable help for the end users when their input fails).

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              sergey.petushkov Sergey Petushkov
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated: