Bug 1295420 - [DOCS] More information on parameter "fieldSelector"
Summary: [DOCS] More information on parameter "fieldSelector"
Keywords:
Status: CLOSED CANTFIX
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.1.0
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: ---
Assignee: Timothy
QA Contact: weiwei jiang
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-01-04 12:43 UTC by Jaspreet Kaur
Modified: 2019-09-12 09:40 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-08-01 00:04:19 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Jaspreet Kaur 2016-01-04 12:43:37 UTC
Document URL: https://access.redhat.com/documentation/en/openshift-enterprise/version-3.1/rest-api-reference/#v1-objectfieldselector

Section Number and Name: 2.3.137. v1.ObjectFieldSelector

Describe the issue: There isn't any mention of how we can use fieldSelector, no syntax provided. Also, which all parameters/spec we can select with this fieldSelector when calling any api call.

Suggestions for improvement: 

Additional information: 

Some of the examples I tried are as below :

GET https://localhost:8443/api/v1/pods?fieldSelector=spec.host=node1.example.com

GET https://localhost:8443/api/v1/nodes?fieldSelector=metadata.name=node1.example.com 

GET https://localhost:8443/api/v1/namespaces/default/endpoints?fieldSelector=metadata.name=router 

GET https://localhost:8443/api/v1/namespaces/default/pods?fieldSelector=metadata.name=docker-registry-1-urb5n 

However, this doesn't seem to be working with services. Hence need a proper documentation on this where it is supported and which parameters can be selected using this.


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