swagger: "2.0"
info:
  contact:
    email: kubesphere@yunify.com
    name: KubeSphere Network
    url: https://kubesphere.io/
  description: KubeSphere Network OpenAPI
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: KubeSphere Network
  version: v0.0.0
  x-taggroups:
  - name: Network
    tags:
    - Network IPPool
    - IPPool Migrate
    - IPPool Status
paths:
  /kapis/network.kubesphere.io/v1alpha2/ippoolmigrations:
    post:
      operationId: MigrateIPPool
      parameters:
      - description: The ippool to be migrated.
        in: formData
        name: oldippool
        type: string
      - description: The ippool you want to migrate to.
        in: formData
        name: newippool
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/v1alpha2.IPPoolResponse'
      summary: Migrate the deployment from ippool to another ippool
      tags:
      - IPPool Migrate
  /kapis/network.kubesphere.io/v1alpha2/ippools:
    get:
      operationId: List
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            items:
              $ref: '#/definitions/v1alpha2.IPPool'
            type: array
      summary: Get ip usage in all ippools
      tags:
      - IPPool Status
  /kapis/network.kubesphere.io/v1alpha2/ippools/{ippool}/migrate:
    get:
      operationId: GetMigrateIPPools
      parameters:
      - description: name of the ippool
        in: path
        name: ippool
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/v1alpha2.IPPoolResponse'
      summary: Get the ippool available for migration
      tags:
      - IPPool Migrate
  /kapis/network.kubesphere.io/v1alpha2/ippools/{name}:
    get:
      operationId: Get
      parameters:
      - description: name of the ippool
        in: path
        name: name
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/v1alpha2.IPPool'
      summary: Get ip usage in ippool with specifying a ippool name
      tags:
      - IPPool Status
  /kapis/network.kubesphere.io/v1alpha2/namespaces/{namespace}/ippools:
    get:
      operationId: GetNamespaceIPPool
      parameters:
      - description: name of the namespace
        in: path
        name: namespace
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ok
          schema:
            $ref: '#/definitions/calicov3.IPPoolList'
      summary: Get the ippool with specifying a namespace
      tags:
      - Network IPPool
definitions:
  calicov3.IPPool:
    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
      metadata:
        $ref: '#/definitions/v1.ObjectMeta'
      spec:
        $ref: '#/definitions/v3.IPPoolSpec'
  calicov3.IPPoolList:
    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
      items:
        items:
          $ref: '#/definitions/calicov3.IPPool'
        type: array
      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
      metadata:
        $ref: '#/definitions/v1.ListMeta'
    required:
    - metadata
    - items
  v1.ListMeta:
    description: ListMeta describes metadata that synthetic resources must have, including
      lists and various status objects. A resource may have only one of {ObjectMeta,
      ListMeta}.
    properties:
      continue:
        description: continue may be set if the user set a limit on the number of
          items returned, and indicates that the server has more data available. The
          value is opaque and may be used to issue another request to the endpoint
          that served this list to retrieve the next set of available objects. Continuing
          a consistent list may not be possible if the server configuration has changed
          or more than a few minutes have passed. The resourceVersion field returned
          when using this continue value will be identical to the value in the first
          response, unless you have received this token from an error message.
        type: string
      remainingItemCount:
        description: remainingItemCount is the number of subsequent items in the list
          which are not included in this list response. If the list request contained
          label or field selectors, then the number of remaining items is unknown
          and the field will be left unset and omitted during serialization. If the
          list is complete (either because it is not chunking or because this is the
          last chunk), then there are no more remaining items and this field will
          be left unset and omitted during serialization. Servers older than v1.15
          do not set this field. The intended use of the remainingItemCount is *estimating*
          the size of a collection. Clients should not rely on the remainingItemCount
          to be set or to be exact.
        format: int64
        type: integer
      resourceVersion:
        description: 'String that identifies the server''s internal version of this
          object that can be used by clients to determine when objects have changed.
          Value must be treated as opaque by clients and passed unmodified back to
          the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
        type: string
      selfLink:
        description: 'Deprecated: selfLink is a legacy read-only field that is no
          longer populated by the system.'
        type: string
  v1.ManagedFieldsEntry:
    description: ManagedFieldsEntry is a workflow-id, a FieldSet and the group version
      of the resource that the fieldset applies to.
    properties:
      apiVersion:
        description: APIVersion defines the version of this resource that this field
          set applies to. The format is "group/version" just like the top-level APIVersion
          field. It is necessary to track the version of a field set because it cannot
          be automatically converted.
        type: string
      fieldsType:
        description: 'FieldsType is the discriminator for the different fields format
          and version. There is currently only one possible value: "FieldsV1"'
        type: string
      fieldsV1:
        description: FieldsV1 holds the first JSON version format as described in
          the "FieldsV1" type.
        type: string
      manager:
        description: Manager is an identifier of the workflow managing these fields.
        type: string
      operation:
        description: Operation is the type of operation which lead to this ManagedFieldsEntry
          being created. The only valid values for this field are 'Apply' and 'Update'.
        type: string
      subresource:
        description: Subresource is the name of the subresource used to update that
          object, or empty string if the object was updated through the main resource.
          The value of this field is used to distinguish between managers, even if
          they share the same name. For example, a status update will be distinct
          from a regular update using the same manager name. Note that the APIVersion
          field is not related to the Subresource field and it always corresponds
          to the version of the main resource.
        type: string
      time:
        description: Time is the timestamp of when the ManagedFields entry was added.
          The timestamp will also be updated if a field is added, the manager changes
          any of the owned fields value or removes a field. The timestamp does not
          update when a field is removed from the entry because another manager took
          it over.
        type: string
  v1.ObjectMeta:
    description: ObjectMeta is metadata that all persisted resources must have, which
      includes all objects users must create.
    properties:
      annotations:
        additionalProperties:
          type: string
        description: 'Annotations is an unstructured key value map stored with a resource
          that may be set by external tools to store and retrieve arbitrary metadata.
          They are not queryable and should be preserved when modifying objects. More
          info: http://kubernetes.io/docs/user-guide/annotations'
        type: object
      creationTimestamp:
        description: |-
          CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

          Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
        type: string
      deletionGracePeriodSeconds:
        description: Number of seconds allowed for this object to gracefully terminate
          before it will be removed from the system. Only set when deletionTimestamp
          is also set. May only be shortened. Read-only.
        format: int64
        type: integer
      deletionTimestamp:
        description: |-
          DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

          Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
        type: string
      finalizers:
        description: Must be empty before the object is deleted from the registry.
          Each entry is an identifier for the responsible component that will remove
          the entry from the list. If the deletionTimestamp of the object is non-nil,
          entries in this list can only be removed. Finalizers may be processed and
          removed in any order.  Order is NOT enforced because it introduces significant
          risk of stuck finalizers. finalizers is a shared field, any actor with permission
          can reorder it. If the finalizer list is processed in order, then this can
          lead to a situation in which the component responsible for the first finalizer
          in the list is waiting for a signal (field value, external system, or other)
          produced by a component responsible for a finalizer later in the list, resulting
          in a deadlock. Without enforced ordering finalizers are free to order amongst
          themselves and are not vulnerable to ordering changes in the list.
        items:
          type: string
        type: array
      generateName:
        description: |-
          GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

          If this field is specified and the generated name exists, the server will return a 409.

          Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
        type: string
      generation:
        description: A sequence number representing a specific generation of the desired
          state. Populated by the system. Read-only.
        format: int64
        type: integer
      labels:
        additionalProperties:
          type: string
        description: 'Map of string keys and values that can be used to organize and
          categorize (scope and select) objects. May match selectors of replication
          controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
        type: object
      managedFields:
        description: ManagedFields maps workflow-id and version to the set of fields
          that are managed by that workflow. This is mostly for internal housekeeping,
          and users typically shouldn't need to set or understand this field. A workflow
          can be the user's name, a controller's name, or the name of a specific apply
          path like "ci-cd". The set of fields is always in the version that the workflow
          used when modifying the object.
        items:
          $ref: '#/definitions/v1.ManagedFieldsEntry'
        type: array
      name:
        description: 'Name must be unique within a namespace. Is required when creating
          resources, although some resources may allow a client to request the generation
          of an appropriate name automatically. Name is primarily intended for creation
          idempotence and configuration definition. Cannot be updated. More info:
          http://kubernetes.io/docs/user-guide/identifiers#names'
        type: string
      namespace:
        description: |-
          Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

          Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
        type: string
      ownerReferences:
        description: List of objects depended by this object. If ALL objects in the
          list have been deleted, this object will be garbage collected. If this object
          is managed by a controller, then an entry in this list will point to this
          controller, with the controller field set to true. There cannot be more
          than one managing controller.
        items:
          $ref: '#/definitions/v1.OwnerReference'
        type: array
      resourceVersion:
        description: |-
          An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

          Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
        type: string
      selfLink:
        description: 'Deprecated: selfLink is a legacy read-only field that is no
          longer populated by the system.'
        type: string
      uid:
        description: |-
          UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

          Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
        type: string
  v1.OwnerReference:
    description: OwnerReference contains enough information to let you identify an
      owning object. An owning object must be in the same namespace as the dependent,
      or be cluster-scoped, so there is no namespace field.
    properties:
      apiVersion:
        description: API version of the referent.
        type: string
      blockOwnerDeletion:
        description: If true, AND if the owner has the "foregroundDeletion" finalizer,
          then the owner cannot be deleted from the key-value store until this reference
          is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
          for how the garbage collector interacts with this field and enforces the
          foreground deletion. Defaults to false. To set this field, a user needs
          "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will
          be returned.
        type: boolean
      controller:
        description: If true, this reference points to the managing controller.
        type: boolean
      kind:
        description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
        type: string
      name:
        description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
        type: string
      uid:
        description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
        type: string
    required:
    - apiVersion
    - kind
    - name
    - uid
  v1alpha2.IPPool:
    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
      metadata:
        $ref: '#/definitions/v1.ObjectMeta'
      spec:
        $ref: '#/definitions/v3.IPPoolSpec'
      status:
        $ref: '#/definitions/v1alpha2.ippoolStatus'
    required:
    - status
  v1alpha2.IPPoolResponse: {}
  v1alpha2.ippoolStatus:
    properties:
      allocations:
        format: int32
        type: integer
      capacity:
        format: int32
        type: integer
      namespaces:
        additionalProperties:
          type: integer
        type: object
      reserved:
        format: int32
        type: integer
      tunnel:
        format: int32
        type: integer
      unallocated:
        format: int32
        type: integer
    required:
    - unallocated
    - allocations
    - capacity
    - tunnel
    - reserved
    - namespaces
  v3.IPIPConfiguration:
    properties:
      enabled:
        type: boolean
      mode:
        type: string
  v3.IPPoolSpec:
    properties:
      allowedUses:
        items:
          type: string
        type: array
      blockSize:
        format: int32
        type: integer
      cidr:
        type: string
      disableBGPExport:
        type: boolean
      disabled:
        type: boolean
      ipip:
        $ref: '#/definitions/v3.IPIPConfiguration'
      ipipMode:
        type: string
      nat-outgoing:
        type: boolean
      natOutgoing:
        type: boolean
      nodeSelector:
        type: string
      vxlanMode:
        type: string
    required:
    - cidr
securityDefinitions:
  jwt:
    in: header
    name: Authorization
    type: apiKey
security:
- jwt: []