[DOCS-13512] Typos on the Stitch Administration API documentation Created: 12/Mar/20  Updated: 29/Oct/23  Resolved: 26/May/21

Status: Closed
Project: Documentation
Component/s: Stitch
Affects Version/s: None
Fix Version/s: None

Type: Typo Priority: Major - P3
Reporter: Kræn Hansen Assignee: Dachary Carey
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 3 years, 47 weeks, 5 days ago
Epic Link: DOCSP-16296
Story Points: 2

 Description   

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.)



 Comments   
Comment by Kræn Hansen [ 13/Mar/20 ]

Great! I paused my endeavors for now, so I believe this is ready to be worked on now. Please just ask questions if I haven't clearly stated the issues.

Comment by Nicholas Larew [ 12/Mar/20 ]

Hey kraen.hansen, thanks for going through the Admin API docs! Historically we haven't had the tooling or resources to deliver a great experience with them, so I really appreciate you helping out. I assigned this ticket to you while you continue to fill it out. When you think it's ready for work leave a comment here so that we can schedule it.

Generated at Thu Feb 08 08:07:59 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.