Zededa EdgeNetworkConfiguration API

swagger: '2.0'
info:
  title: ZEDEDA App Profiles Service AppProfileService EdgeNetworkConfiguration 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: EdgeNetworkConfiguration
paths:
  /v1/networks:
    get:
      summary: Query edge networks
      description: Query the edge network records.
      operationId: EdgeNetworkConfiguration_QueryEdgeNetworks
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetConfigList'
        '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: projectName
        in: query
        required: false
        type: string
      - name: namePattern
        in: query
        required: false
        type: string
      - name: projectNamePattern
        in: query
        required: false
        type: string
      - name: dist
        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: defaultNetwork
        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: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
    post:
      summary: Create edge network
      description: Create an edge network record.
      operationId: EdgeNetworkConfiguration_CreateEdgeNetwork
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '400':
          description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of 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'
        '409':
          description: Conflict. The API gateway did not process the request because this edge network record will conflict with an already existing edge network record.
          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: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NetConfig'
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
  /v1/networks/id/{id}:
    get:
      summary: Get edge network
      description: Get the configuration (without security details) of an edge network record.
      operationId: EdgeNetworkConfiguration_GetEdgeNetwork
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetConfig'
        '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
        description: System defined universally unique Id of the network
        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:
      - EdgeNetworkConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
    delete:
      summary: Delete edge network
      description: Delete an edge network record.
      operationId: EdgeNetworkConfiguration_DeleteEdgeNetwork
      responses:
        '200':
          description: A successful response.
          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'
        '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
        description: System defined universally unique Id of the network
        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:
      - EdgeNetworkConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
    put:
      summary: Update edge network
      description: Update an edge network. The usual pattern to update an edge network record is to retrieve the record and update with the modified values in a new body to update the edge network record.
      operationId: EdgeNetworkConfiguration_UpdateEdgeNetwork
      responses:
        '200':
          description: A successful response.
          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'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          schema:
            $ref: '#/definitions/ZsrvResponse'
        '409':
          description: Conflict. The API gateway did not process the request because this operation will conflict with an already existing edge network record.
          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: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NetConfigForUpdate_HttpRequest'
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        type: string
      tags:
      - EdgeNetworkConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
  /v1/networks/id/{id}/devices:
    get:
      summary: Get edge network devices by id
      description: Get the list of devices associated with the specified network.
      operationId: EdgeNetworkConfiguration_GetEdgeNetworkDevicesById
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetworkDeviceList'
        '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
        description: System defined universally unique Id of the network
        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:
      - EdgeNetworkConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
  /v1/networks/name/{name}:
    get:
      summary: Get edge network
      description: Get the configuration (without security details) of an edge network record.
      operationId: EdgeNetworkConfiguration_GetEdgeNetworkByName
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/NetConfig'
        '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
        description: User defined name of the network, unique across the enterprise. Once object is created, name can’t be changed
        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:
      - EdgeNetworkConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
definitions:
  NetworkWirelessType:
    type: string
    enum:
    - NETWORK_WIRELESS_TYPE_UNSPECIFIED
    - NETWORK_WIRELESS_TYPE_WIFI
    - NETWORK_WIRELESS_TYPE_CELLULAR
    default: NETWORK_WIRELESS_TYPE_UNSPECIFIED
  NtpServer:
    type: object
    properties:
      server:
        type: string
        description: NTP Server IP or FQDN
    description: NTP Server
    title: NTP Server
  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
  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
  NetworkDeviceList:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/NetworkRelatedDevice'
  NetCellularAccessPointSecrets:
    type: object
    properties:
      username:
        type: string
        description: Cellular Username
      password:
        type: string
        description: Cellular Password
  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
  commonCipherBlock:
    type: object
    properties:
      cipherContextId:
        type: string
        title: cipher context id
      initialValue:
        type: string
        format: byte
        title: Initial Value for Symmetric Key derivation
      cipherData:
        type: string
        format: byte
        title: encrypted sensitive data
      clearTextSha256:
        type: string
        format: byte
        title: sha256 of the plaintext sensitive data
    title: Encrypted sensitive data information
  commonCellularIPType:
    type: string
    enum:
    - CELLULAR_IP_TYPE_UNSPECIFIED
    - CELLULAR_IP_TYPE_IPV4
    - CELLULAR_IP_TYPE_IPV4_AND_IPV6
    - CELLULAR_IP_TYPE_IPV6
    default: CELLULAR_IP_TYPE_UNSPECIFIED
    description: "The IP addressing type to use for a given attach or default bearer.\n\n - CELLULAR_IP_TYPE_UNSPECIFIED: IP type is not specified.\nWhen unspecified, EVE will not enforce an IP type in the bearer configuration.\nThe modem will instead use its built-in profiles (see CellularProfile) to determine\nthe appropriate IP type for the network.\n - CELLULAR_IP_TYPE_IPV4: IPv4 only.\n - CELLULAR_IP_TYPE_IPV4_AND_IPV6: IPv4 and IPv6.\n - CELLULAR_IP_TYPE_IPV6: IPv6 only."
  NetConfigList:
    type: object
    properties:
      summary:
        $ref: '#/definitions/Summary'
        title: Summary has been deprecated
      summaryByKind:
        $ref: '#/definitions/Summary'
      summaryByProxy:
        $ref: '#/definitions/Summary'
      summaryByDist:
        $ref: '#/definitions/Summary'
      list:
        type: array
        items:
          $ref: '#/definitions/NetConfig'
      next:
        $ref: '#/definitions/Cursor'
  NetworkDHCPType:
    type: string
    enum:
    - NETWORK_DHCP_TYPE_UNSPECIFIED
    - NETWORK_DHCP_TYPE_STATIC
    - NETWORK_DHCP_TYPE_PASSTHROUGH
    - NETWORK_DHCP_TYPE_DEPRECATED
    - NETWORK_DHCP_TYPE_CLIENT
    - NETWORK_DHCP_TYPE_STATIC_ADAPTER_SPECIFIC
    default: NETWORK_DHCP_TYPE_UNSPECIFIED
    title: "- NETWORK_DHCP_TYPE_STATIC: used for adapter configured DHCP static\n - NETWORK_DHCP_TYPE_PASSTHROUGH: used for adapter configured DHCP none, application will do DHCP\n - NETWORK_DHCP_TYPE_DEPRECATED: used for application simulation\n - NETWORK_DHCP_TYPE_CLIENT: used for adapter configured DHCP client\n - NETWORK_DHCP_TYPE_STATIC_ADAPTER_SPECIFIC: used to configure device adapter specific static networks"
  NetworkProxyProto:
    type: string
    enum:
    - NETWORK_PROXY_PROTO_HTTP
    - NETWORK_PROXY_PROTO_HTTPS
    - NETWORK_PROXY_PROTO_SOCKS
    - NETWORK_PROXY_PROTO_FTP
    - NETWORK_PROXY_PROTO_OTHER
    default: NETWORK_PROXY_PROTO_HTTP
  dhcpIpRange:
    type: object
    properties:
      start:
        type: string
        description: starting IP
      end:
        type: string
        description: ending IP
    description: DHCP IP range
    title: DHCP IP range
  NetWifiConfigNetcryptoblock:
    type: object
    properties:
      identity:
        type: string
      password:
        type: string
  NetCellularAccessPoint:
    type: object
    properties:
      simSlot:
        type: integer
        format: int64
        description: 'SIM card slot to which this configuration applies.

          0 - unspecified (apply to currently activated or the only available)

          1 - config for SIM card in the first slot

          2 - config for SIM card in the second slot

          etc.'
      apn:
        type: string
        description: 'Access Point Network to connect into.

          By default it is "internet".'
      authProtocol:
        $ref: '#/definitions/evecommonCellularAuthProtocol'
        description: Authentication protocol used by the network.
      cipherData:
        $ref: '#/definitions/commonCipherBlock'
        description: 'Cipher data may contain encrypted user credentials

          (inside cellNetUsername and cellNetPassword fields).'
      preferredPlmns:
        type: array
        items:
          type: string
        description: 'The set of cellular network operators that modem should preferably try to register

          and connect into.

          Network operator should be referenced by PLMN (Public Land Mobile Network) code,

          consisting of 3-digits MCC (Mobile Country Code) and 2 or 3-digits MNC (Mobile Network Code),

          separated by a dash, e.g. "310-260".

          If empty, then modem will select the network automatically based on the SIM card config.'
      forbidRoaming:
        type: boolean
        description: If true, then modem will avoid connecting to networks with roaming.
      preferredRats:
        type: array
        items:
          $ref: '#/definitions/evecommonRadioAccessTechnology'
        description: 'The list of preferred Radio Access Technologies (RATs) to use for connecting

          to the network.

          Order matters, first is the most preferred, second is tried next, etc.

          Not listed technologies will not be tried.

          If empty, then modem will select RAT automatically.'
      ipType:
        $ref: '#/definitions/commonCellularIPType'
        description: The IP addressing type to use for the default bearer.
      attachApn:
        type: string
        description: 'Access Point Name (APN) for the attach (initial) bearer.

          This field is optional. If not specified, EVE will not send any attach bearer

          configuration to the modem. Instead, the modem will use one of its pre-installed

          profiles (see CellularProfile) to determine the configuration.'
      attachIpType:
        $ref: '#/definitions/commonCellularIPType'
        description: 'The IP addressing type to use for the attach bearer.

          Leave undefined if attach_apn is not specified.'
      attachAuthProtocol:
        $ref: '#/definitions/CellularAuthProtocol'
        description: 'Authentication protocol used for the attach bearer.

          Leave undefined if attach_apn is not specified.'
      secrets:
        $ref: '#/definitions/NetCellularAccessPointSecrets'
      encryptedSecrets:
        type: object
        additionalProperties:
          type: string
      cryptoKey:
        type: string
      attachSecrets:
        $ref: '#/definitions/NetCellularAccessPointSecrets'
      attachEncryptedSecrets:
        type: object
        additionalProperties:
          type: string
  NetProjectInfo:
    type: object
    properties:
      projectId:
        type: string
        description: system generated unique id for a project
        readOnly: true
        pattern: '[0-9A-Za-z-]+'
      projectName:
        type: string
        description: project name
  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.
  StaticDNSList:
    type: object
    properties:
      hostname:
        type: string
        description: Host name
      addrs:
        type: array
        items:
          type: string
        description: Addresses
    description: Static DNS list
    title: Static DNS list
  ObjectRevision:
    type: object
    properties:
      prev:
        type: string
        description: Previous
      curr:
        type: string
        description: Current Database version of the record
      createdAt:
        type: object
        format: date-time
        description: The time, in milliseconds since the epoch, when the record was created.
      createdBy:
        type: string
        description: 'User data: Created By'
      updatedAt:
        type: object
        format: date-time
        description: The time, in milliseconds since the epoch, when the record was last updated.
      updatedBy:
        type: string
        description: 'User data: Updated By'
    description: ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
    title: ObjectRevision is used to store the user information.
    required:
    - curr
    - createdAt
    - createdBy
    - updatedAt
    - updatedBy
  NetCellularConfig:
    type: object
    properties:
      APN:
        type: string
        description: 'APN string - by default it is "internet".

          TO BE DEPRECATED: Fill connection arguments inside access_points instead.

          If access_points is non-empty, then APN field is ignored.'
      probe:
        $ref: '#/definitions/configCellularConnectivityProbe'
        description: 'Optional cellular connectivity probing.

          By default it is enabled.'
      locationTracking:
        type: boolean
        description: 'Some LTE modems have GNSS receiver integrated and can be used for device

          location tracking.

          Enable this option to have location info periodically obtained from this

          modem and published to controller and to applications.'
      accessPoints:
        type: array
        items:
          $ref: '#/definitions/NetCellularAccessPoint'
        description: 'Parameters to apply for connecting to cellular networks.

          Configured separately for every SIM card inserted into the modem.'
      activatedSimSlot:
        type: integer
        format: int64
        description: 'Select SIM card slot to activate.

          Currently, EVE support only single-standby SIM card mode.

          0 - unspecified (leave the currently activated)

          1 - activate the first SIM slot

          2 - activate the second SIM slot

          etc.'
  NetProxyServer:
    type: object
    properties:
      proto:
        type: object
        $ref: '#/definitions/NetworkProxyProto'
        description: Net Proxy proto
      server:
        type: string
        description: Net Proxy Server
      port:
        type: number
        format: int64
        description: Net Proxy Port
    description: Net Proxy Server
    title: Net Proxy Server
  NetWifiConfig:
    type: object
    properties:
      wifiSSID:
        type: string
      keyScheme:
        $ref: '#/definitions/NetworkWiFiKeyScheme'
      identity:
        type: string
      secret:
        $ref: '#/definitions/NetWifiConfigSecrets'
      crypto:
        $ref: '#/

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