Bug 1322467 - Example api curl output is extremely limited
Summary: Example api curl output is extremely limited
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 2.2.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Vikram Goyal
QA Contact: Vikram Goyal
Vikram Goyal
URL:
Whiteboard:
Depends On: 1322457
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-03-30 14:24 UTC by Eric Jones
Modified: 2019-10-10 11:43 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-09-08 20:25:19 UTC
Target Upstream Version:


Attachments (Terms of Use)

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.


Note You need to log in before you can comment on or make changes to this bug.