Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-13512

Typos on the Stitch Administration API documentation

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: Stitch
    • Labels:
      None

      Description

      I am reading about the Stitch Administration API and I'm finding a few typos, this ticket is not ready to be worked on, just yet.
      I would like to keep this ticket around so I can list the typos as I find them:

      • Both the Secrets APIs and the Dependency APIs is incorrectly at the top-route (the URL path should contain groupId and appId).
      • Creating an application doesn't state that the response also has a body containing the details on the resulting application.
      • Getting the users profile response schema has "roles[].group_id" typed as "Any", but it's "string".
      • Updating a secret incorrectly states that the response has a body - it's empty.
      • Creating an auth-provider incorrectly states that the response is empty, when it does actually contain details about the newly created auth provider.
      • Deleting a session (i.e. logging out a user) states that it takes an access token in the header - but if such a token is sent, the server responds with "invalid refresh token: incorrect token type".

      Still investigating:

      • I believe the "Get information about the underlying Atlas mongod." is misplaced.
      • I'm surprised that the HTTP method to set the allowed HTTP origins is a POST instead of a PUT.
      • Creating a function, it seems the "run_as_system" parameter is missing from the request body.
      • Executing a function seems to be missing a schema for the request body.

      Scope of changes

      Impact to Other Docs

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

            Assignee:
            dachary.carey@mongodb.com Dachary Carey
            Reporter:
            kraen.hansen@mongodb.com Kræn Hansen
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved:
              4 years, 6 weeks, 5 days ago