Bug 1330808 - The description of the "name" parameter is wrong for services/proxy apis
Summary: The description of the "name" parameter is wrong for services/proxy apis
Keywords:
Status: NEW
Alias: None
Product: OKD
Classification: Red Hat
Component: Documentation
Version: 3.x
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: ---
Assignee: Nobody
QA Contact: Ronaldo Rivera
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-04-27 02:53 UTC by weiwei jiang
Modified: 2022-01-14 13:13 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed:
Target Upstream Version:


Attachments (Terms of Use)

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:


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