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

Base URL isn't reflected in API examples

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Fixed
    • Icon: Major - P3 Major - P3
    • None
    • None
    • Cloud Manager, Ops Manager
    • None

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

      Attachments

        Activity

          People

            tony.sansone@mongodb.com Anthony Sansone (Inactive)
            amit.jain@mongodb.com Amit Jain
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              4 years, 44 weeks ago