This is a cache of https://docs.openshift.com/container-platform/4.17/rest_api/project_apis/projectrequest-project-openshift-io-v1.html. It is a snapshot of the page at 2024-11-28T08:18:52.133+0000.
ProjectRequest [project.openshift.io/v1] - Project <strong>api</strong>s | <strong>api</strong> reference | OpenShift Container Platform 4.17
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
×

ProjectRequest [project.openshift.io/v1]

Description

ProjectRequest is the set of options necessary to fully qualify a project request

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

Type

object

Specification

Property Type Description

apiVersion

string

apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

description

string

Description is the description to apply to a project

displayName

string

DisplayName is the display name to apply to a project

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

api endpoints

The following api endpoints are available:

  • /apis/project.openshift.io/v1/projectrequests

    • GET: list objects of kind ProjectRequest

    • POST: create a ProjectRequest

/apis/project.openshift.io/v1/projectrequests

HTTP method

GET

Description

list objects of kind ProjectRequest

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

Status_v7 schema

401 - Unauthorized

Empty
HTTP method

POST

Description

create a ProjectRequest

Table 2. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 3. Body parameters
Parameter Type Description

body

ProjectRequest schema
Table 4. HTTP responses
HTTP code Reponse body

200 - OK

ProjectRequest schema

201 - Created

ProjectRequest schema

202 - Accepted

ProjectRequest schema

401 - Unauthorized

Empty