Zededa EdgeNetworkInstanceStatus API

swagger: '2.0'
info:
  title: ZEDEDA App Profiles Service AppProfileService EdgeNetworkInstanceStatus API
  description: The ZEDEDA App Profiles Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their app profiles on ZEDEDA platform and to manage them remotely.
  termsOfService: https://www.zededa.com/terms
  version: '1.0'
  contact:
    name: ZEDEDA API Support
    url: https://www.zededa.com/support
    email: support@zededa.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
basePath: /api
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- BearerToken: []
tags:
- name: EdgeNetworkInstanceStatus
paths:
  /v1/netinsts/id/{id}/status:
    get:
      summary: Get edge network instance status
      description: Get the status of an edge network instance as reported by the edge node where the edge network instance has been deployed.
      operationId: EdgeNetworkInstanceStatus_GetEdgeNetworkInstanceStatus
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetInstStatusMsg'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: id
        in: path
        required: true
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceStatus
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
  /v1/netinsts/name/{name}/status:
    get:
      summary: Get edge network instance status
      description: Get the status of an edge network instance as reported by the edge node where the edge network instance has been deployed.
      operationId: EdgeNetworkInstanceStatus_GetEdgeNetworkInstanceStatusByName
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetInstStatusMsg'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: name
        in: path
        required: true
        type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceStatus
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
  /v1/netinsts/status:
    get:
      summary: Query status of edge network instances
      description: Query the status of edge network instances as reported by the edge nodes where the edge network instances have been deployed.
      operationId: EdgeNetworkInstanceStatus_QueryEdgeNetworkInstanceStatus
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetInstStatusListMsg'
        '400':
          description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: deviceName
        in: query
        required: false
        type: string
      - name: projectName
        in: query
        required: false
        type: string
      - name: namePattern
        in: query
        required: false
        type: string
      - name: tags
        in: query
        required: false
        type: string
      - name: runState
        in: query
        required: false
        type: string
        enum:
        - UNSPECIFIED
        - ONLINE
        - HALTED
        - INIT
        - REBOOTING
        - OFFLINE
        - UNKNOWN
        - UNPROVISIONED
        - PROVISIONED
        - SUSPECT
        - DOWNLOADING
        - RESTARTING
        - PURGING
        - HALTING
        - ERROR
        - VERIFYING
        - LOADING
        - CREATING_VOLUME
        - BOOTING
        - MAINTENANCE_MODE
        - START_DELAYED
        - BASEOS_UPDATING
        - PREPARING_POWEROFF
        - POWERING_OFF
        - PREPARED_POWEROFF
        default: UNSPECIFIED
      - name: deviceNamePattern
        in: query
        required: false
        type: string
      - name: projectNamePattern
        in: query
        required: false
        type: string
      - name: type
        in: query
        required: false
        type: integer
        format: int32
      - name: kind
        in: query
        required: false
        type: integer
        format: int32
      - name: summary
        in: query
        required: false
        type: boolean
      - name: next.pageToken
        description: Page Token
        in: query
        required: false
        type: string
      - name: next.orderBy
        description: OrderBy helps in sorting the list response
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: next.pageNum
        description: Page Number
        in: query
        required: false
        type: number
        format: int64
      - name: next.pageSize
        description: Defines the page size
        in: query
        required: false
        type: number
        format: int64
      - name: next.totalPages
        description: Total number of pages to be fetched.
        in: query
        required: false
        type: number
        format: int64
      - name: fields
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceStatus
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
  /v1/netinsts/status-config:
    get:
      summary: Query status and config of edge network instances
      description: Query the status and config of edge network instances as reported by the edge nodes where the edge network instances have been deployed.
      operationId: EdgeNetworkInstanceStatus_QueryEdgeNetworkInstanceStatusConfig
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetInstConfigStatusList'
        '400':
          description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: deviceName
        in: query
        required: false
        type: string
      - name: projectName
        in: query
        required: false
        type: string
      - name: namePattern
        in: query
        required: false
        type: string
      - name: tags
        in: query
        required: false
        type: string
      - name: runState
        in: query
        required: false
        type: string
        enum:
        - UNSPECIFIED
        - ONLINE
        - HALTED
        - INIT
        - REBOOTING
        - OFFLINE
        - UNKNOWN
        - UNPROVISIONED
        - PROVISIONED
        - SUSPECT
        - DOWNLOADING
        - RESTARTING
        - PURGING
        - HALTING
        - ERROR
        - VERIFYING
        - LOADING
        - CREATING_VOLUME
        - BOOTING
        - MAINTENANCE_MODE
        - START_DELAYED
        - BASEOS_UPDATING
        - PREPARING_POWEROFF
        - POWERING_OFF
        - PREPARED_POWEROFF
        default: UNSPECIFIED
      - name: deviceNamePattern
        in: query
        required: false
        type: string
      - name: projectNamePattern
        in: query
        required: false
        type: string
      - name: type
        in: query
        required: false
        type: integer
        format: int32
      - name: kind
        in: query
        required: false
        type: integer
        format: int32
      - name: summary
        in: query
        required: false
        type: boolean
      - name: next.pageToken
        description: Page Token
        in: query
        required: false
        type: string
      - name: next.orderBy
        description: OrderBy helps in sorting the list response
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: next.pageNum
        description: Page Number
        in: query
        required: false
        type: number
        format: int64
      - name: next.pageSize
        description: Defines the page size
        in: query
        required: false
        type: number
        format: int64
      - name: next.totalPages
        description: Total number of pages to be fetched.
        in: query
        required: false
        type: number
        format: int64
      - name: fields
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceStatus
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
  /v1/netinsts/tags:
    get:
      summary: Query Network instance tags
      description: Netork instance tags LIST API is to fetch the interfaces tags attached to app instances.
      operationId: EdgeNetworkInstanceStatus_GetNetworkInstanceInterfaceTags
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/ObjectTagsList'
        '400':
          description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '401':
          description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '403':
          description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '500':
          description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '504':
          description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
      - name: next.pageToken
        description: Page Token
        in: query
        required: false
        type: string
      - name: next.orderBy
        description: OrderBy helps in sorting the list response
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: next.pageNum
        description: Page Number
        in: query
        required: false
        type: number
        format: int64
      - name: next.pageSize
        description: Defines the page size
        in: query
        required: false
        type: number
        format: int64
      - name: next.totalPages
        description: Total number of pages to be fetched.
        in: query
        required: false
        type: number
        format: int64
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkInstanceStatus
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
definitions:
  ZcOpsType:
    type: string
    enum:
    - OPS_TYPE_UNSPECIFIED
    - OPS_TYPE_READ
    - OPS_TYPE_DELETE
    - OPS_TYPE_CREATE
    - OPS_TYPE_UPDATE
    - OPS_TYPE_LIST
    default: OPS_TYPE_UNSPECIFIED
    title: ZedCloud internal operation type
  Severity:
    type: string
    enum:
    - SEVERITY_UNSPECIFIED
    - SEVERITY_NOTICE
    - SEVERITY_WARNING
    - SEVERITY_ERROR
    default: SEVERITY_UNSPECIFIED
    title: Severity tells the severity type
  ObjectType:
    type: string
    enum:
    - OBJECT_TYPE_UNSPECIFIED
    - OBJECT_TYPE_USER
    - OBJECT_TYPE_EDGE_NODE
    - OBJECT_TYPE_EDGE_APP
    - OBJECT_TYPE_IMAGE
    - OBJECT_TYPE_EDGE_APP_INSTANCE
    - OBJECT_TYPE_PROJECT
    - OBJECT_TYPE_NETWORK
    - OBJECT_TYPE_DATASTORE
    - OBJECT_TYPE_SERVICE
    - OBJECT_TYPE_SERVICE_INSTANCE
    - OBJECT_TYPE_ENTERPRISE
    - OBJECT_TYPE_ROLE
    - OBJECT_TYPE_CREDENTIAL
    - OBJECT_TYPE_NETWORK_INSTANCE
    - OBJECT_TYPE_VOLUME_INSTANCE
    - OBJECT_TYPE_REALM
    - OBJECT_TYPE_AUTHPROFILE
    - OBJECT_TYPE_POLICY
    - OBJECT_TYPE_APP_POLICY
    - OBJECT_TYPE_CLUSTER_INSTANCE
    - OBJECT_TYPE_PLUGIN
    - OBJECT_TYPE_DOC_POLICY
    - OBJECT_TYPE_ORCHESTRATOR_CLUSTER
    - OBJECT_TYPE_TAGS
    - OBJECT_TYPE_EDGE_NODE_INTERFACE
    - OBJECT_TYPE_DEPLOYMENT
    - OBJECT_TYPE_ENTITLEMENTS
    - OBJECT_TYPE_DATA_STREAM
    - OBJECT_TYPE_API_USAGE
    - OBJECT_TYPE_APP_INSTANCE_SNAPSHOT
    - OBJECT_TYPE_PATCH_ENVELOPE
    - OBJECT_TYPE_RESOURCE_USAGE_TRACK
    - OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE
    - OBJECT_TYPE_DEV_PASSTHROUGH
    - OBJECT_TYPE_EDGE_NODE_CLUSTER
    - OBJECT_TYPE_ASSET_GROUP
    - OBJECT_TYPE_APP_PROFILE
    - OBJECT_TYPE_PROFILE_DEPLOYMENT
    - OBJECT_TYPE_ZKS_INSTANCE
    - OBJECT_TYPE_CLUSTER_GROUP
    default: OBJECT_TYPE_UNSPECIFIED
  NetInstStatusSummaryMsg:
    type: object
    example:
      id: d85a545f-6510-4327-b03d-c02eef119e99
      name: sample-app
    properties:
      id:
        type: string
        description: System defined universally unique Id of the network instance
        readOnly: true
        pattern: '[0-9A-Za-z-]+'
        uniqueItems: true
      name:
        type: string
        description: User defined name of the network instance, unique across the enterprise. Once object is created, name can’t be changed
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
        uniqueItems: true
      runState:
        $ref: '#/definitions/RunState'
      upTimeStamp:
        type: string
        format: date-time
      uplinkIntf:
        type: string
      tags:
        type: object
        additionalProperties:
          type: string
        description: Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.
        maxLength: 32
        pattern: ^[^<%&?/\>]+$
      clusterID:
        type: string
        description: User defined name of the clusterInstance, unique across the enterprise.
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
        uniqueItems: true
      type:
        $ref: '#/definitions/NetworkInstanceDhcpType'
      kind:
        $ref: '#/definitions/NetworkInstanceKind'
      deviceId:
        type: string
      projectId:
        type: string
      deviceName:
        type: string
      projectName:
        type: string
      edgeNodeClusterID:
        type: string
    description: Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge applications within a single Edge node and within a logical group of Edge nodes. This provides summary status of a Network instance.
    title: Network instance summary status
  Summary:
    type: object
    properties:
      description:
        type: string
        description: Summary description
      total:
        type: number
        format: int64
        description: Total
      values:
        type: object
        additionalProperties:
          type: integer
          format: int64
        description: 'Values: Map for storing <string, uint32>'
    description: Summary is used to store the Summary details
    title: Summary is used to store the Summary details
  VifInfo:
    type: object
    properties:
      vifName:
        type: string
      macAddress:
        type: string
      appName:
        type: string
  IoBundleStatus:
    type: object
    properties:
      type:
        type: object
        $ref: '#/definitions/IoType'
        description: IoType specifies the type of the Input output of the device
      name:
        type: string
        description: Io Bundle status name
      members:
        type: array
        items:
          type: string
        description: Member Array
        title: members - Deprecated by memberList
      appName:
        type: string
        description: Application name
      lteInfo:
        type: object
        $ref: '#/definitions/LTEAdapter'
        description: LTE information
      err:
        $ref: '#/definitions/DeviceError'
        description: Device error details
        title: 6 - DEPRECATED
      memberList:
        type: array
        items:
          $ref: '#/definitions/IoMemberStatus'
        description: List of IO members
    description: IoBundleStatus is used to store the status of the Input Output bundle
    title: IoBundleStatus is used to store the status of the Input Output bundle
    required:
    - type
    - name
    - members
    - appName
  NetInstStatusMsg:
    type: object
    example:
      id: d85a545f-6510-4327-b03d-c02eef119e99
      name: sample-app
    properties:
      id:
        type: string
        description: System defined universally unique Id of the network instance
        readOnly: true
        pattern: '[0-9A-Za-z-]+'
        uniqueItems: true
      name:
        type: string
        description: User defined name of the network instance, unique across the enterprise. Once object is created, name can’t be changed
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
        uniqueItems: true
      deviceId:
        type: string
        title: device on which this network is running
      runState:
        $ref: '#/definitions/RunState'
      upTimeStamp:
        type: string
        format: date-time
      tags:
        type: object
        additionalProperties:
          type: string
        description: Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.
        maxLength: 32
        pattern: ^[^<%&?/\>]+$
      clusterID:
        type: string
        description: System defined universally unique clusterInstance ID, unique across the enterprise.
        maxLength: 256
        minLength: 3
        pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
        uniqueItems: true
      projectId:
        type: string
      kind:
        $ref: '#/definitions/NetworkInstanceKind'
      bridgeNum:
        type: integer
        format: int64
      bridgeName:
        type: string
      bridgeIPAddr:
        type: string
      ipMappings:
        type: array
        items:
          $ref: '#/definitions/IPAssignment'
      vifs:
        type: array
        items:
          $ref: '#/definitions/VifInfo'
      ipv4Eid:
        type: boolean
      assignedAdapters:
        type: array
        items:
          $ref: '#/definitions/IoBundleStatus'
      uplinkIntf:
        type: string
      mtu:
        type: integer
        format: int64
        description: Maximum transmission unit (MTU) to set for the network instance and all application interfaces connected to it
      ipRoutes:
        type: array
        items:
          $ref: '#/definitions/eveinfoIPRoute'
        description: List of IP routes used by the network instance
      ports:
        type: array
        items:
          type: string
        description: List of ports used by the network instance
      errInfo:
        type: array
        items:
          $ref: '#/definitions/DeviceError'
      rawStatus:
        type: string
    description: Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge applications within a single Edge node and within a logical group of Edge nodes. This provides detailed status of a Network instance.
    title: Network instance detailed status
  NetworkInstanceDhcpType:
    type: string
    enum:
    - NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED
    - NETWORK_INSTANCE_DHCP_TYPE_V4
    - NETWORK_INSTANCE_DHCP_TYPE_V6
    - NETWORK_INSTANCE_DHCP_TYPE_CRYPTOEID
    - NETWORK_INSTANCE_DHCP_TYPE_CRYPTOV4
    - NETWORK_INSTANCE_DHCP_TYPE_CRYPTOV6
    default: NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED
    title: "NetworkInstanceDhcpType: Used in the network instance provide\n   dhcp server configuration"
  Entity:
    type: string
    enum:
    - ENTITY_UNSPECIFIED
    - ENTITY_BASE_OS
    - ENTITY_SYSTEM_ADAPTER
    - ENTITY_VAULT
    - ENTITY_ATTESTATION
    - ENTITY_APP_INSTANCE
    - ENTITY_PORT
    - ENTITY_NETWORK
    - ENTITY_NETWORK_INSTANCE
    - ENTITY_CONTENT_TREE
    - ENTITY_CONTENT_BLOB
    - ENTITY_VOLUME
    default: ENTITY_UNSPECIFIED
    description: "- ENTITY_UNSPECIFIED: Invalid Device Entity\n - ENTITY_BASE_OS: Base OS entity\n - ENTITY_SYSTEM_ADAPTER: System Adapter Entity\n - ENTITY_VAULT: Vault Entity\n - ENTITY_ATTESTATION: Attestation Entity\n - ENTITY_APP_INSTANCE: App Instance Entity\n - ENTITY_PORT: Port Entity\n - ENTITY_NETWORK: Network Entity\n - ENTITY_NETWORK_INSTANCE: Network Instance Entity\n - ENTITY_CONTENT_TREE: ContentTree Entity\n - ENTITY_CONTENT_BLOB: Blob Entity\n - ENTITY_VOLUME: VOLUME Entity"
    title: Edge node components
  DeviceError:
    type: object
    properties:
      description:
        type: string
        description: Description of the error
      severity:
        type: string
        $ref: '#/definitions/Severity'
        description: Severity of the error
      timestamp:
        type: object
        format: date-time
        description: Timestamp at which error had occurred
      entities:
        type: array
        items:
          $ref: '#/definitions/DeviceEntity'
        description: objects referenced by the description or retry_condition
      retryCondition:
        type: string
        description: condition for retry
    description: DeviceError store the error occurred at the device side
    title: DeviceError is used to store the error details of the hardware.
    required:
    - description
    - severity
    - timestamp
    - entities
  ObjectTagsList:
    type: object
    properties:
      objectTags:
        type: array
        items:
          $ref: '#/definitions/ObjectTag'
        description: Details of Object tags list records.
      next:
        $ref: '#/definitions/Cursor'
        description: Returned record page.
    description: Returned list of Object tags matched by filter criteria
    title: Object tag list records
  protobufAny:
    type: object
    properties:
      typeUrl:
        type: string
      value:
        type: string
        format: byte
  Cursor:
    type: object
    properties:
      pageToken:
        type: string
        description: Page Token
      orderBy:
        type: array
        items:
          type: string
        description: OrderBy helps in sorting the list response
      pageNum:
        type: number
        format: int64
        description: Page Number
      pageSize:
        type: number
        format: int64
        description: Defines the page size
      totalPages:
        type: number
        format: int64
        description: Total number of pages to be fetched.
    description: 'Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc. '
    title: Cursor is used as filter in list operation.
  DeviceEntity:
    type: object
    properties:
      entity:
        $ref: '#/definitions/Entity'
      entityId:
        type: string
      entityName:
        type: string
  IoType:
    type: string
    enum:
    - IO_TYPE_UNSPECIFIED
    - IO_TYPE_ETH
    - IO_TYPE_USB
    - IO_TYPE_COM
    - IO_TYPE_AUDIO
    - IO_TYPE_WLAN
    - IO_TYPE_WWAN
    - IO_TYPE_HDMI
    - IO_TYPE_LTE
    - IO_TYPE_STORAGE_NVME_DEVICE
    - IO_TYPE_STORAGE_SATA_DEVICE
    - IO_TYPE_ETH_PF
    - IO_TYPE_ETH_VF
    - IO_TYPE_USB_CONTROLLER
    - IO_TYPE_USB_DEVICE
    - IO_TYPE_CAN
    - IO_TYPE_VCAN
    - IO_TYPE_LCAN
    - IO_TYPE_OTHER
    default: IO_TYPE_UNSPECIFIED
    description: "- IO_TYPE_UNSPECIFIED: No operation/ Invalid peration\n - IO_TYPE_ETH: Ethernet\n - IO_TYPE_USB: USB Type - General\n - IO_TYPE_COM: Communication Port\n - IO_TYPE_AUDIO: Audio Port\n - IO_TYPE_WLAN: wireless LAN\n - IO_TYPE_WWAN: Wireless wide area network\n - IO_TYPE_HDMI: High-Definition Multimedia Interface\n - IO_TYPE_LTE: LTE Interfaces\n - IO_TYPE_STORAGE_NVME_DEVICE: Storage NVME device\n - IO_TYPE_STORAGE_SATA_DEVICE: Storage SATA device\n - IO_TYPE_ETH_PF: Physical Interface (PF) of the Virtual Functions\n - IO_TYPE_ETH_VF: Virtual Function (VF)\n - IO_TYPE_USB_CONTROLLER: USB Type - Controller\n - IO_TYPE_USB_DEVICE: USB Type - Device\n - IO_TYPE_CAN: CAN - Device\n - IO_TYPE_VCAN: VCAN - Virtual CAN device\n - IO_TYPE_LCAN: LCAN - Logical CAN device\n - IO_TYPE_OTHER: Other Io Types"
    title: Input/Output Type
  ZcOpsStatus:
    type: string
    enum:
    - OPS_STATUS_UNSPECIFIED
    - OPS_STATUS_PENDING
    - OPS_STATUS_ONGOING
    - OPS_STATUS_COMPLETE
    default: OPS_STATUS_UNSPECIFIED
    description: "- OPS_STATUS_PENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING\n - OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING.\n - OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases."
    title: ZedCloud internal operation status
  LTEAdapter:
    type: object
    properties:
      simName:
        type: string
        description: Name of SIM card.
      cellModuleName:
        type: string
        description: Name of Cell Module
      imsi:
        type: string
        description: imsi of the SIM
      iccid:
        type: string
        description: iccid of the 

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-edgenetworkinstancestatus-api-openapi.yml