github.com/cloudwan/edgelq-sdk@v1.15.4/devices/proto/api-skeleton-v1.yaml (about)

     1  name: devices.edgelq.com
     2  proto:
     3    package:
     4      name: ntt.devices
     5      currentVersion: v1
     6      goPackage: github.com/cloudwan/edgelq/devices
     7      protoImportPathPrefix: edgelq/devices/proto
     8    service:
     9      name: Devices
    10      defaultHost: devices.edgelq.com
    11      oauthScopes: https://apis.edgelq.com
    12  
    13  imports:
    14  - iam.edgelq.com
    15  - logging.edgelq.com
    16  - monitoring.edgelq.com
    17  - cellular-api.edgelq.com
    18  
    19  resources:
    20  - name: Project
    21    multiRegion:
    22      isPolicyHolder: true
    23  
    24  - name: DeviceHardware
    25    parents:
    26    - Project
    27    scopeAttributes:
    28    - Region
    29    actions:
    30    - name: Deregister
    31      withStoreHandle:
    32        readOnly: false
    33        transaction: SNAPSHOT
    34  
    35  - name: DeviceHardwareRegisterSession
    36    parents:
    37    - Project
    38    scopeAttributes:
    39    - Region
    40    actions:
    41    - name: GetDeviceHardwareRegisterSessionFromToken
    42      multiRegionRouting:
    43        skipCodeGenBasedRouting: true
    44      grpcTranscoding:
    45        httpMethod: get
    46      opResourceInfo:
    47        skipResourceInRequest: true
    48        isCollection: true
    49        isPlural: false
    50      withStoreHandle:
    51        readOnly: true
    52        transaction: NONE
    53    - name: RegisterHardware
    54      opResourceInfo:
    55        skipResourceInRequest: true
    56        isCollection: true
    57        isPlural: false
    58      multiRegionRouting:
    59        skipCodeGenBasedRouting: true
    60      streamingRequest: false
    61      streamingResponse: false
    62      withStoreHandle:
    63        transaction: MANUAL
    64    - name: HardwareStatus
    65      grpcTranscoding:
    66        httpMethod: get
    67      opResourceInfo:
    68        skipResourceInRequest: true
    69        isCollection: true
    70        isPlural: false
    71      multiRegionRouting:
    72        skipCodeGenBasedRouting: true
    73      streamingRequest: false
    74      streamingResponse: false
    75      withStoreHandle:
    76        readOnly: true
    77        transaction: NONE
    78  
    79  - name: TpmAttestationCert
    80    parents:
    81    - Project
    82    - ""
    83  
    84  - name: Device
    85    parents:
    86    - Project
    87    scopeAttributes:
    88    - Region
    89    actions:
    90    - name: GetDedicatedEndpoints
    91      withStoreHandle:
    92        readOnly: false
    93        transaction: SNAPSHOT
    94    - name: ProvisionServiceAccountToDevice
    95      verb: provision_service_account_to_device
    96      withStoreHandle:
    97        transaction: MANUAL
    98    - name: RemoveServiceAccountFromDevice
    99      verb: remove_service_account_from_device
   100      withStoreHandle:
   101        readOnly: false
   102        transaction: SNAPSHOT
   103    - name: Heartbeat
   104      verb: heartbeat
   105      responseName: HeartbeatResponse
   106      skipResponseMsgGen: true
   107      requestName: HeartbeatMsg
   108      skipRequestMsgGen: true
   109      streamingRequest: true
   110      streamingResponse: true
   111      withStoreHandle:
   112        transaction: MANUAL
   113    - name: ReportDeviceMetrics
   114      verb: report_device_metrics
   115      skipResponseMsgGen: false
   116      skipRequestMsgGen: false
   117      streamingRequest: true
   118      streamingResponse: true
   119      withStoreHandle:
   120        transaction: MANUAL
   121  
   122  - name: ProvisioningPolicy
   123    plural: ProvisioningPolicies
   124    parents:
   125    - Project
   126    scopeAttributes:
   127    - Region
   128    actions:
   129    - name: ProvisionServiceAccountToProvisioningPolicy
   130      verb: provision_service_account_to_provisioning_policy
   131      withStoreHandle:
   132        transaction: MANUAL
   133    - name: RemoveServiceAccountFromProvisioningPolicy
   134      verb: remove_service_account_from_provisioning_policy
   135      withStoreHandle:
   136        readOnly: false
   137        transaction: SNAPSHOT
   138    - name: ProvisionDeviceViaPolicy
   139      verb: provision_device_via_policy
   140      withStoreHandle:
   141        transaction: MANUAL
   142    - name: RequestProvisioningApproval
   143      verb: request_provisioning_approval
   144      withStoreHandle:
   145        transaction: MANUAL
   146  
   147  - name: ProvisioningApprovalRequest
   148    parents:
   149    - ProvisioningPolicy
   150    actions:
   151    - name: ProvisionDeviceForApprovedRequest
   152      verb: provision_device_for_approved_request
   153      withStoreHandle:
   154        transaction: MANUAL
   155  
   156  - name: CustomizedImage
   157    parents:
   158    - Project
   159    scopeAttributes:
   160    - Region
   161    actions:
   162    - name: RequestUrl
   163      verb: request_url
   164      withStoreHandle:
   165        readOnly: true
   166        transaction: SNAPSHOT
   167  
   168  - name: DeviceType
   169  
   170  - name: OsVersion
   171  
   172  - name: OsImageProfile
   173    parents:
   174    - Project
   175    scopeAttributes:
   176    - Region
   177  
   178  - name: DeviceDistributionCounter
   179    optOuts:
   180      basicActions: 
   181      - CreateDeviceDistributionCounter
   182      - UpdateDeviceDistributionCounter
   183      - DeleteDeviceDistributionCounter
   184      dbConstraints: true
   185    parents:
   186    - Project
   187    scopeAttributes:
   188    - Region
   189    multiRegion:
   190      syncType: NEVER
   191  
   192  apis:
   193  - name: Public
   194    actions:
   195    - name: ListPublicDevices
   196      grpcTranscoding:
   197        httpMethod: get
   198      opResourceInfo:
   199        name: Device
   200        isPlural: true
   201        isCollection: true
   202        responsePaths:
   203          resourceBody: [ "devices" ]
   204      withStoreHandle:
   205        readOnly: true
   206        transaction: NONE
   207  - name: ZtpProvisionHardware
   208    actions:
   209    - name: ProvisionHardware
   210      multiRegionRouting:
   211        skipCodeGenBasedRouting: true
   212      streamingRequest: true
   213      streamingResponse: true
   214      withStoreHandle:
   215        transaction: MANUAL