Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1322467

Summary: Example api curl output is extremely limited
Product: OpenShift Container Platform Reporter: Eric Jones <erjones>
Component: DocumentationAssignee: Vikram Goyal <vigoyal>
Status: CLOSED NOTABUG QA Contact: Vikram Goyal <vigoyal>
Severity: unspecified Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 2.2.0CC: aos-bugs, jokerman, mmccomas, tiwillia
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-09-08 20:25:19 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1322457    
Bug Blocks:    

Description Eric Jones 2016-03-30 14:24:28 UTC 
Document URL: 
https://access.redhat.com/documentation/en-US/OpenShift_Online/2.0/html-single/REST_API_Guide/index.html#Version2

Section Number and Name: 
Chapter 2. General API Information
⁠2.2. Version

Describe the issue: 
The example provided at the beginning of that section returns a lot more information than just the supported_api_versions, and yet the example output only shows the supported_api_versions. 

Suggestions for improvement:
Provide a full example of the output so that the full output is expected, and not just the supported_api_versions.
Comment 1 Timothy Williams 2016-09-08 20:25:19 UTC 
With every API request made to the openshift server, a list of possible api endpoints is provided so that the api configuration does not have to be assumed, it can be known. There isn't any other additional important information provided by this API endpoint. Below is an example of an actual call to a 2.2.10 server, minus the api configuration:

{
    "api_version": 1.7, 
    "data": {
        [ API CONFIGURATION INFO REDACTED ]
    }, 
    "messages": [], 
    "status": "ok", 
    "supported_api_versions": [
        1.0, 
        1.1000000000000001, 
        1.2, 
        1.3, 
        1.3999999999999999, 
        1.5, 
        1.6000000000000001, 
        1.7
    ], 
    "type": "links", 
    "version": "1.7"
}

I don't believe the example needs updating.