logo
Doom
English
简体中文
English
简体中文
logo
Doom
Introduction
Getting Started

Usage

Configuration
Convention
Markdown
MDX
Internationalization
API Documentation
Permission Description Document
Referencing Documents
Deployment

APIs

Advanced API

Event APIs

Search

Log APIs

Aggregation
Search
CodeQualityTaskSummary
Projects

Workload APIs

DaemonSet [apps/v1]
Deployments [apps/v1]

CRDs

ArtifactCleanupRun

Public References

CodeQuality
CodeQualityBranch
📝 Edit this page on GitHub
Previous PageCodeQualityTaskSummary
Next PageWorkload APIs

#Projects

/plugins/v1alpha1/template/projects#

getListProjects#

Parameters#

  • itemsPerPage (in query): string

    items to be returned in a page

  • page (in query): string

    page to be returned

Response#

  • 200ProjectList: OK

postCreateProject#

Request Body#

Projectrequired

Response#

  • 201Project: Project Created

ProjectList#

TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.

  • 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

  • items: []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: ListMeta

    ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Project#

  • 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

  • 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

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

  • spec: ProjectSpec

ProjectSpec#

  • access: Addressable
  • address: Addressable
  • extendedAddresses: map[string]Addressable
  • limited: boolean
  • namespaceRefs: []ObjectReference
  • properties: string
  • public: boolean
  • readOnly: boolean
  • subType: string

Addressable#

  • url: string

ObjectReference#

ObjectReference contains enough information to let you inspect or modify the referred object.

  • apiVersion: string

    API version of the referent.

  • fieldPath: string

    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

  • kind: string

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  • name: string

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

  • namespace: string

    Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

  • resourceVersion: string

    Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

  • uid: string

    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids