[DOCS-12557] Base URL isn't reflected in API examples Created: 20/Mar/19  Updated: 29/Oct/23  Resolved: 11/Apr/19

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

Type: Task Priority: Major - P3
Reporter: Amit Jain Assignee: Anthony Sansone (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Sub-Tasks:
Key
Summary
Type
Status
Assignee
DOCS-12619 Backport DOCS-12557 to v4.0 Backport Sub-Task Closed Anthony Sansone  
Participants:
Days since reply: 4 years, 44 weeks ago
Epic Link: DOCSP-1743
Story Points: 0.2

 Description   

Description

On some of the API docs pages, the example URL doesn't take into account the base URL.

  • On the Cloud Manager page the example URL is

    https://cloud.mongodb.com/groups/{GROUP-ID}/hosts/{HOST-ID}/measurements?granularity={TIME-INCREMENT}&period={PERIOD}&pretty=true

    but it should be

    https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/hosts/{HOST-ID}/measurements?granularity={TIME-INCREMENT}&period={PERIOD}&pretty=true

  • Similarly, on the Ops Manager page, it says

    https://{OPSMANAGER-HOST}:{PORT}/groups/{GROUP-ID}/hosts/{HOST-ID}/measurements?granularity={TIME-INCREMENT}&period={PERIOD}}&pretty=true

    when it should say

    https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{GROUP-ID}/hosts/{HOST-ID}/measurements?granularity={TIME-INCREMENT}&period={PERIOD}}&pretty=true

    We might even want to change the base URL in the OM docs to just be

    <OM Central URL>/api/public/v1.0

    to reflect that their OM web server may not be running SSL.

  • The equivalent Atlas API page appears to be fine, except for an extra '}' in the example URL.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

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



 Comments   
Comment by Githook User [ 11/Apr/19 ]

Author:

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

Message: (DOCS-12557): Fixed API typo.
Branch: master
https://github.com/10gen/mms-docs/commit/269dbe5cddf2766f5505355c4f601477cb7e9b58

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