[DOCS-13933] [Atlas] roles data type is referred to as a "string array", where it should actually be an "array of documents" Created: 16/Oct/20  Updated: 29/Oct/23  Resolved: 26/Oct/20

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

Type: Task Priority: Major - P3
Reporter: Ethan Steininger (Inactive) Assignee: Steve Renaker (Inactive)
Resolution: Fixed Votes: 0
Labels: cet-captain
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 3 years, 15 weeks, 2 days ago
Epic Link: DOCSP-7540
Story Points: 2

 Description   

Description

On the Atlas API documentation page for creating a user: https://docs.atlas.mongodb.com/reference/api/database-users-create-a-user/

I believe the roles data type is mischaracterized as a "string array" whereas it should be an "array of documents".
Additionally it would be helpful if there was a sample payload, because my structure keeps getting errors:

payload:

  {    "databaseName": "sample_mflix",    "deleteAfterDate": "2020-10-25T10:49:40Z",    "username": "foo",    "password": "bar",    "roles": [        {            "databaseName": "admin",            "roleName": "atlasAdmin",            "collectionName": "users"        }    ]  }

response:

{    "detail": "Invalid attribute roleName specified.",    "error": 400,    "errorCode": "INVALID_ATTRIBUTE",    "parameters": [        "roleName"    ],    "reason": "Bad Request"}

Scope of changes

Impact to Other Docs

MVP (Work and Date)

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



 Comments   
Comment by Steve Renaker (Inactive) [ 26/Oct/20 ]

PR: https://github.com/10gen/cloud-docs/pull/1914

Comment by Steve Renaker (Inactive) [ 19/Oct/20 ]

ethan.steininger thanks for filing this ticket. I updated the data type for the roles field, and it will be visible next time the Atlas docs are published. Regarding the sample payload, there's already a sample request near the bottom of the page with a valid example payload. Is that what you had in mind?

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