edgelet/api/managementVersion_2019_01_30.yaml [7:300]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tags:
  - name: Module
    x-displayName: Modules
    description: |
      Create and manage modules.
  - name: Identity
    x-displayName: Identities
    description: |
      Create and manage module identity.
  - name: SystemInformation
    x-displayName: SystemInformation
    description: |
      Get information about the runtime.
paths:
  /modules:
    get:
      tags:
        - Module
      summary: List modules.
      produces:
        - application/json
      description: |
        This returns the list of currently running modules and their statuses.
      operationId: ListModules
      parameters:
        - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/ModuleList'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
    post:
      tags:
        - Module
      summary: Create module.
      operationId: CreateModule
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: body
          name: module
          required: true
          schema:
            $ref: '#/definitions/ModuleSpec'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ModuleDetails'
        '409':
          description: Conflict. Returned if module already exists.
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}':
    get:
      tags:
        - Module
      summary: Get a module's status.
      operationId: GetModule
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to get. (urlencoded)
          required: true
          type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/ModuleDetails'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
    put:
      tags:
        - Module
      summary: Update a module.
      operationId: UpdateModule
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to update. (urlencoded)
          required: true
          type: string
        - name: start
          in: query
          description: Flag indicating whether module should be started after updating.
          required: false
          type: boolean
          default: false
          allowEmptyValue: true
        - in: body
          name: module
          required: true
          schema:
            $ref: '#/definitions/ModuleSpec'
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/ModuleDetails'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
    delete:
      tags:
        - Module
      summary: Delete a module.
      operationId: DeleteModule
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to delete. (urlencoded)
          required: true
          type: string
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/prepareupdate':
    post:
      tags:
        - Module
      summary: Prepare to update a module.
      operationId: PrepareUpdateModule
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to update. (urlencoded)
          required: true
          type: string
        - in: body
          name: module
          required: true
          schema:
            $ref: '#/definitions/ModuleSpec'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/start':
    post:
      tags:
        - Module
      summary: Start a module.
      operationId: StartModule
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to start. (urlencoded)
          required: true
          type: string
      responses:
        '204':
          description: No Content
        '304':
          description: Not Modified
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/stop':
    post:
      tags:
        - Module
      summary: Stop a module.
      operationId: StopModule
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to stop. (urlencoded)
          required: true
          type: string
      responses:
        '204':
          description: No Content
        '304':
          description: Not Modified
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/restart':
    post:
      tags:
        - Module
      summary: Restart a module.
      operationId: RestartModule
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to restart. (urlencoded)
          required: true
          type: string
      responses:
        '204':
          description: No Content
        '304':
          description: Not Modified
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/logs':
    get:
      tags:
        - Module
      summary: Get module logs.
      operationId: ModuleLogs
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to obtain logs for. (urlencoded)
          required: true
          type: string
        - in: query
          name: follow
          description: Return the logs as a stream.
          type: boolean
          default: false
        - in: query
          name: tail
          description: Only return this number of lines from the end of the logs.
          type: string
          default: "all"
        - in: query
          name: since
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



edgelet/api/managementVersion_2020_07_07.yaml [7:300]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tags:
  - name: Module
    x-displayName: Modules
    description: |
      Create and manage modules.
  - name: Identity
    x-displayName: Identities
    description: |
      Create and manage module identity.
  - name: SystemInformation
    x-displayName: SystemInformation
    description: |
      Get information about the runtime.
paths:
  /modules:
    get:
      tags:
        - Module
      summary: List modules.
      produces:
        - application/json
      description: |
        This returns the list of currently running modules and their statuses.
      operationId: ListModules
      parameters:
        - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/ModuleList'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
    post:
      tags:
        - Module
      summary: Create module.
      operationId: CreateModule
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: body
          name: module
          required: true
          schema:
            $ref: '#/definitions/ModuleSpec'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/ModuleDetails'
        '409':
          description: Conflict. Returned if module already exists.
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}':
    get:
      tags:
        - Module
      summary: Get a module's status.
      operationId: GetModule
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to get. (urlencoded)
          required: true
          type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/ModuleDetails'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
    put:
      tags:
        - Module
      summary: Update a module.
      operationId: UpdateModule
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to update. (urlencoded)
          required: true
          type: string
        - name: start
          in: query
          description: Flag indicating whether module should be started after updating.
          required: false
          type: boolean
          default: false
          allowEmptyValue: true
        - in: body
          name: module
          required: true
          schema:
            $ref: '#/definitions/ModuleSpec'
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/ModuleDetails'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
    delete:
      tags:
        - Module
      summary: Delete a module.
      operationId: DeleteModule
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to delete. (urlencoded)
          required: true
          type: string
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/prepareupdate':
    post:
      tags:
        - Module
      summary: Prepare to update a module.
      operationId: PrepareUpdateModule
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to update. (urlencoded)
          required: true
          type: string
        - in: body
          name: module
          required: true
          schema:
            $ref: '#/definitions/ModuleSpec'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/start':
    post:
      tags:
        - Module
      summary: Start a module.
      operationId: StartModule
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to start. (urlencoded)
          required: true
          type: string
      responses:
        '204':
          description: No Content
        '304':
          description: Not Modified
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/stop':
    post:
      tags:
        - Module
      summary: Stop a module.
      operationId: StopModule
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to stop. (urlencoded)
          required: true
          type: string
      responses:
        '204':
          description: No Content
        '304':
          description: Not Modified
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/restart':
    post:
      tags:
        - Module
      summary: Restart a module.
      operationId: RestartModule
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to restart. (urlencoded)
          required: true
          type: string
      responses:
        '204':
          description: No Content
        '304':
          description: Not Modified
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
  '/modules/{name}/logs':
    get:
      tags:
        - Module
      summary: Get module logs.
      operationId: ModuleLogs
      parameters:
        - $ref: '#/parameters/api-version'
        - in: path
          name: name
          description: The name of the module to obtain logs for. (urlencoded)
          required: true
          type: string
        - in: query
          name: follow
          description: Return the logs as a stream.
          type: boolean
          default: false
        - in: query
          name: tail
          description: Only return this number of lines from the end of the logs.
          type: string
          default: "all"
        - in: query
          name: since
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



