Bug 1330808

Summary: The description of the "name" parameter is wrong for services/proxy apis
Product: OKD Reporter: weiwei jiang <wjiang>
Component: DocumentationAssignee: Nobody <nobody>
Status: NEW --- QA Contact: Ronaldo Rivera <rrivera>
Severity: medium Docs Contact:
Priority: medium    
Version: 3.xCC: aos-bugs, mmccomas, wsun
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: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description weiwei jiang 2016-04-27 02:53:20 UTC 
Document URL: 
1> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-put-requests-to-proxy-of-service
2> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-post-requests-to-proxy-of-service
3> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-delete-requests-to-proxy-of-service
4> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-options-requests-to-proxy-of-service
5> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-head-requests-to-proxy-of-service
6> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-get-requests-to-proxy-of-service
7> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-put-requests-to-proxy-of-service-2
8> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-post-requests-to-proxy-of-service-2
9> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-delete-requests-to-proxy-of-service-2
10> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-options-requests-to-proxy-of-service-2
11> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-head-requests-to-proxy-of-service-2
12> https://docs.openshift.org/latest/rest_api/kubernetes_v1.html#connect-get-requests-to-proxy-of-service-2

Section Number and Name: 
rest_api/kubernetes_v1

Describe the issue: 
The description of the "name" parameter is wrong.

Suggestions for improvement: 
The description of the "name" parameter should be "<procotol>:<service_name>:<port_name or port_number>" for example, http:hello-openshift:8080|8080-tcp for oc new-app openshift/hello-openshift:latest or http:frontend:web|5432 for https://github.com/openshift/origin/blob/master/examples/sample-app/application-template-stibuild.json

Additional information: