[DOCS-11165] Fix Cloud Manager Restore Jobs API Examples for Endpoint Case-Sensitivity Created: 03/Jan/18  Updated: 29/Oct/23  Resolved: 18/Jan/18

Status: Closed
Project: Documentation
Component/s: API, Cloud Manager, Code Examples, Ops Manager
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Luke Phillippi Assignee: Anthony Sansone (Inactive)
Resolution: Fixed Votes: 0
Labels: typo
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

https://docs.cloudmanager.mongodb.com/reference/api/restore-jobs/


Issue Links:
Related
Participants:
Days since reply: 6 years, 3 weeks, 6 days ago
Story Points: 0.2

 Description   

Within the Restore Jobs section of the Cloud Manager API documentation (as well as it's child sections), various examples depict the endpoint as:

/groups/{GROUP-ID}/clusters/{CLUSTER-ID}/restorejobs

However, the restorejobs portion of the endpoint should include an uppercase "J": restoreJobs.

Attempts to call the endpoints using the lowercase restorejobs result in the following RESOURCE_NOT_FOUND error:

$ curl --user "$CLOUD_USERNAME:$CLOUD_API_KEY" --digest  --header "Accept: application/json"  --header "Content-Type: application/json"  --include  --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/5a4cf4fedf9db10bdc849d4a/clusters/5a4cf7a94e6581190d3dad1f/restorejobs?pretty=true"
HTTP/1.1 401 Unauthorized
Date: Wed, 03 Jan 2018 15:44:37 GMT
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="lF/HUP84T4bsOdDhzpNkk/uBbxz2nSsm", algorithm=MD5, qop="auth", stale=false
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 106
 
HTTP/1.1 404 Not Found
Date: Wed, 03 Jan 2018 15:44:37 GMT
Content-Length: 335
Content-Type: application/json
 
{
  "detail" : "Cannot find resource /api/public/v1.0/groups/5a4cf4fedf9db10bdc849d4a/clusters/5a4cf7a94e6581190d3dad1f/restorejobs.",
  "error" : 404,
  "errorCode" : "RESOURCE_NOT_FOUND",
  "parameters" : [ "/api/public/v1.0/groups/5a4cf4fedf9db10bdc849d4a/clusters/5a4cf7a94e6581190d3dad1f/restorejobs" ],
  "reason" : "Not Found"
}

The same API call, using the uppercase "J" succeeds as follows:

$ curl --user "$CLOUD_USERNAME:$CLOUD_API_KEY" --digest  --header "Accept: application/json"  --header "Content-Type: application/json"  --include  --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/5a4cf4fedf9db10bdc849d4a/clusters/5a4cf7a94e6581190d3dad1f/restoreJobs?pretty=true"
HTTP/1.1 401 Unauthorized
Date: Wed, 03 Jan 2018 16:44:40 GMT
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="rBuSfaW7O2n0uf+DjaUurQoJRahjltD0", algorithm=MD5, qop="auth", stale=false
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 106
 
HTTP/1.1 200 OK
Date: Wed, 03 Jan 2018 16:44:40 GMT
Content-Length: 258
Content-Type: application/json
Strict-Transport-Security: max-age=300
 
{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/5a4cf4fedf9db10bdc849d4a/clusters/5a4cf7a94e6581190d3dad1f/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ ],
  "totalCount" : 0
}

As such, the examples within the documentation should be updated to accurately reflect the uppercase "J" in restoreJobs.



 Comments   
Comment by Githook User [ 18/Jan/18 ]

Author:

{'name': 'Anthony Sansone', 'email': 'tony.sansone@mongodb.com', 'username': 'atsansone'}

Message: (DOCS-11165): Fix capitalization issue on restoreJobs API.
Branch: v3.6
https://github.com/10gen/mms-docs/commit/836f39cb3fa757f6c7b0a0892f8bf9be529a73fc

Comment by Githook User [ 18/Jan/18 ]

Author:

{'name': 'Anthony Sansone', 'email': 'tony.sansone@mongodb.com', 'username': 'atsansone'}

Message: (DOCS-11165): Fix capitalization issue on restoreJobs API.
Branch: master
https://github.com/10gen/mms-docs/commit/d21aeb9a30f1f0dfe5596198ed5238b1ab232eeb

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