Bug 1295420

Summary:	[DOCS] More information on parameter "fieldSelector"
Product:	OpenShift Container Platform	Reporter:	Jaspreet Kaur <jkaur>
Component:	Documentation	Assignee:	Timothy <tpoitras>
Status:	CLOSED CANTFIX	QA Contact:	weiwei jiang <wjiang>
Severity:	high	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	high
Version:	3.1.0	CC:	aos-bugs, deads, jokerman, 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:	2016-08-01 00:04: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:

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.