Tigera Projectcalico Org API

The projectcalicoOrg API from Tigera — 1 operation(s) for projectcalicoorg.

OpenAPI Specification

tigera-projectcalicoorg-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Generic API Server Projectcalico Org API
  version: unversioned
tags:
- name: projectcalicoOrg
paths:
  /apis/projectcalico.org/:
    get:
      description: get information of a group
      tags:
      - projectcalicoOrg
      operationId: getProjectcalicoOrgAPIGroup
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup'
            application/yaml:
              schema:
                $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup'
components:
  schemas:
    io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup:
      description: APIGroup contains the name, the supported versions, and the preferred version of a group.
      type: object
      required:
      - name
      - versions
      properties:
        apiVersion:
          description: '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'
          type: string
        kind:
          description: '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'
          type: string
        name:
          description: name is the name of the group.
          type: string
        preferredVersion:
          description: preferredVersion is the version preferred by the API server, which probably is the storage version.
          $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery'
        serverAddressByClientCIDRs:
          description: 'a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.'
          type: array
          items:
            $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR'
        versions:
          description: versions are the versions supported in this group.
          type: array
          items:
            $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery'
      x-kubernetes-group-version-kind:
      - group: ''
        kind: APIGroup
        version: v1
    io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery:
      description: GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.
      type: object
      required:
      - groupVersion
      - version
      properties:
        groupVersion:
          description: groupVersion specifies the API group and version in the form "group/version"
          type: string
        version:
          description: version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.
          type: string
    io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR:
      description: ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
      type: object
      required:
      - clientCIDR
      - serverAddress
      properties:
        clientCIDR:
          description: The CIDR with which clients can match their IP to figure out the server address that they should use.
          type: string
        serverAddress:
          description: Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.
          type: string