edgelet/api/workloadVersion_2019_01_30.yaml [227:455]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'

definitions:
  ModuleList:
    type: object
    properties:
      modules:
        type: array
        items:
          $ref: '#/definitions/ModuleDetails'
    required:
      - modules
  ModuleDetails:
    type: object
    properties:
      id:
        type: string
        description: System generated unique identitier.
        example: happy_hawking
      name:
        type: string
        description: The name of the module.
        example: edgeHub
      type:
        type: string
        description: The type of a module.
        example: docker
      config:
        $ref: '#/definitions/Config'
      status:
        $ref: '#/definitions/Status'
    required:
      - id
      - name
      - type
      - config
      - status
  Config:
    type: object
    properties:
      settings:
        type: object
        example:
          image: 'microsoft/azureiotedge-hub:1.0'
          createOptions:
            HostConfig:
              PortBindings:
                '22/tcp':
                  - HostPort: '11022'
      env:
        type: array
        items:
          $ref: '#/definitions/EnvVar'
    required:
      - settings
  Status:
    type: object
    properties:
      startTime:
        type: string
        format: date-time
      exitStatus:
        $ref: '#/definitions/ExitStatus'
      runtimeStatus:
        $ref: '#/definitions/RuntimeStatus'
    required:
      - runtimeStatus
  EnvVar:
    type: object
    properties:
      key:
        type: string
        example: the_key
      value:
        type: string
        example: the_value
    required:
      - key
      - value
  ExitStatus:
    type: object
    properties:
      exitTime:
        type: string
        format: date-time
      statusCode:
        type: string
    required:
      - exitTime
      - statusCode
    example:
      exitTime: '2018-04-03T09:31:00.000Z'
      statusCode: '101'
  RuntimeStatus:
    type: object
    properties:
      status:
        type: string
      description:
        type: string
    required:
      - status
    example:
      status: the status
      description: the description
  SignRequest:
    type: object
    properties:
      keyId:
        type: string
        description: Name of key to perform sign operation.
        example: device_key
      algo:
        type: string
        description: Sign algorithm to be used.
        enum:
          - HMACSHA256
      data:
        type: string
        format: byte
        description: Data to be signed.
    required:
      - keyId
      - algo
      - data
  SignResponse:
    type: object
    properties:
      digest:
        type: string
        format: byte
        description: Signature of the data.
    required:
      - digest
  EncryptRequest:
    type: object
    properties:
      plaintext:
        type: string
        format: byte
        description: The data to be encrypted.
      initializationVector:
        type: string
        format: byte
        description: An initialization vector used to encrypt the data.
    required:
      - plaintext
      - initializationVector
  EncryptResponse:
    type: object
    properties:
      ciphertext:
        type: string
        format: byte
        description: The encrypted form of the data encoded in base 64.
    required:
      - ciphertext
  DecryptRequest:
    type: object
    properties:
      ciphertext:
        type: string
        format: byte
        description: The data to be decrypted.
      initializationVector:
        type: string
        format: byte
        description: An initialization vector used to decrypt the data.
    required:
      - ciphertext
      - initializationVector
  DecryptResponse:
    type: object
    properties:
      plaintext:
        type: string
        format: byte
        description: The decrypted form of the data encoded in base 64.
    required:
      - plaintext
  ServerCertificateRequest:
    type: object
    properties:
      commonName:
        type: string
        description: Subject common name
      expiration:
        type: string
        format: date-time
        description: Certificate expiration date-time (ISO 8601)
    required:
      - commonName
      - expiration
  IdentityCertificateRequest:
    type: object
    properties:
      expiration:
        type: string
        format: date-time
        description: Certificate expiration date-time (ISO 8601)
  CertificateResponse:
    type: object
    properties:
      privateKey:
        $ref: '#/definitions/PrivateKey'
      certificate:
        type: string
        format: bytes
        description: Base64 encoded PEM formatted byte array containing the certificate and its chain.
      expiration:
        type: string
        format: date-time
        description: Certificate expiration date-time (ISO 8601)
    required:
      - privateKey
      - certificate
      - expiration
  TrustBundleResponse:
    type: object
    properties:
      certificate:
        type: string
        format: bytes
        description: Base64 encoded PEM formatted byte array containing the trusted certificates.
    required:
      - certificate
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



edgelet/api/workloadVersion_2020_07_07.yaml [244:472]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'

definitions:
  ModuleList:
    type: object
    properties:
      modules:
        type: array
        items:
          $ref: '#/definitions/ModuleDetails'
    required:
      - modules
  ModuleDetails:
    type: object
    properties:
      id:
        type: string
        description: System generated unique identitier.
        example: happy_hawking
      name:
        type: string
        description: The name of the module.
        example: edgeHub
      type:
        type: string
        description: The type of a module.
        example: docker
      config:
        $ref: '#/definitions/Config'
      status:
        $ref: '#/definitions/Status'
    required:
      - id
      - name
      - type
      - config
      - status
  Config:
    type: object
    properties:
      settings:
        type: object
        example:
          image: 'microsoft/azureiotedge-hub:1.0'
          createOptions:
            HostConfig:
              PortBindings:
                '22/tcp':
                  - HostPort: '11022'
      env:
        type: array
        items:
          $ref: '#/definitions/EnvVar'
    required:
      - settings
  Status:
    type: object
    properties:
      startTime:
        type: string
        format: date-time
      exitStatus:
        $ref: '#/definitions/ExitStatus'
      runtimeStatus:
        $ref: '#/definitions/RuntimeStatus'
    required:
      - runtimeStatus
  EnvVar:
    type: object
    properties:
      key:
        type: string
        example: the_key
      value:
        type: string
        example: the_value
    required:
      - key
      - value
  ExitStatus:
    type: object
    properties:
      exitTime:
        type: string
        format: date-time
      statusCode:
        type: string
    required:
      - exitTime
      - statusCode
    example:
      exitTime: '2018-04-03T09:31:00.000Z'
      statusCode: '101'
  RuntimeStatus:
    type: object
    properties:
      status:
        type: string
      description:
        type: string
    required:
      - status
    example:
      status: the status
      description: the description
  SignRequest:
    type: object
    properties:
      keyId:
        type: string
        description: Name of key to perform sign operation.
        example: device_key
      algo:
        type: string
        description: Sign algorithm to be used.
        enum:
          - HMACSHA256
      data:
        type: string
        format: byte
        description: Data to be signed.
    required:
      - keyId
      - algo
      - data
  SignResponse:
    type: object
    properties:
      digest:
        type: string
        format: byte
        description: Signature of the data.
    required:
      - digest
  EncryptRequest:
    type: object
    properties:
      plaintext:
        type: string
        format: byte
        description: The data to be encrypted.
      initializationVector:
        type: string
        format: byte
        description: An initialization vector used to encrypt the data.
    required:
      - plaintext
      - initializationVector
  EncryptResponse:
    type: object
    properties:
      ciphertext:
        type: string
        format: byte
        description: The encrypted form of the data encoded in base 64.
    required:
      - ciphertext
  DecryptRequest:
    type: object
    properties:
      ciphertext:
        type: string
        format: byte
        description: The data to be decrypted.
      initializationVector:
        type: string
        format: byte
        description: An initialization vector used to decrypt the data.
    required:
      - ciphertext
      - initializationVector
  DecryptResponse:
    type: object
    properties:
      plaintext:
        type: string
        format: byte
        description: The decrypted form of the data encoded in base 64.
    required:
      - plaintext
  ServerCertificateRequest:
    type: object
    properties:
      commonName:
        type: string
        description: Subject common name
      expiration:
        type: string
        format: date-time
        description: Certificate expiration date-time (ISO 8601)
    required:
      - commonName
      - expiration
  IdentityCertificateRequest:
    type: object
    properties:
      expiration:
        type: string
        format: date-time
        description: Certificate expiration date-time (ISO 8601)
  CertificateResponse:
    type: object
    properties:
      privateKey:
        $ref: '#/definitions/PrivateKey'
      certificate:
        type: string
        format: bytes
        description: Base64 encoded PEM formatted byte array containing the certificate and its chain.
      expiration:
        type: string
        format: date-time
        description: Certificate expiration date-time (ISO 8601)
    required:
      - privateKey
      - certificate
      - expiration
  TrustBundleResponse:
    type: object
    properties:
      certificate:
        type: string
        format: bytes
        description: Base64 encoded PEM formatted byte array containing the trusted certificates.
    required:
      - certificate
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



