openapi.yaml

swagger: "2.0"
info:
  title: Arduino Create Agent
  description: "A companion of Arduino Create. \n\tAllows the website to perform operations
    on the user computer, \n\tsuch as detecting which boards are connected and upload
    sketches on them."
  version: ""
host: localhost:80
consumes:
- application/json
- application/xml
- application/gob
produces:
- application/json
- application/xml
- application/gob
paths:
  /v2/docs/pkgs:
    get:
      summary: Download docs/pkgs.html
      operationId: docs#/v2/docs/pkgs
      responses:
        "200":
          description: File downloaded
          schema:
            type: file
      schemes:
      - http
  /v2/pkgs/indexes:
    get:
      tags:
      - indexes
      summary: list indexes
      operationId: indexes#list
      responses:
        "200":
          description: OK response.
          schema:
            type: array
            items:
              type: string
              example: Harum nostrum qui ipsa minima quia dolorem.
        "400":
          description: Bad Request response.
          schema:
            $ref: '#/definitions/Indexeslist_invalid_url_response_body'
      schemes:
      - http
  /v2/pkgs/indexes/add:
    post:
      tags:
      - indexes
      summary: add indexes
      operationId: indexes#add
      parameters:
      - name: AddRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/IndexesAddRequestBody'
          required:
          - url
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/IndexesAddResponseBody'
        "400":
          description: Bad Request response.
          schema:
            $ref: '#/definitions/Indexesadd_invalid_url_response_body'
      schemes:
      - http
  /v2/pkgs/indexes/delete:
    post:
      tags:
      - indexes
      summary: remove indexes
      operationId: indexes#remove
      parameters:
      - name: RemoveRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/IndexesRemoveRequestBody'
          required:
          - url
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/IndexesRemoveResponseBody'
        "400":
          description: Bad Request response.
          schema:
            $ref: '#/definitions/Indexesremove_invalid_url_response_body'
      schemes:
      - http
  /v2/pkgs/tools/available:
    get:
      tags:
      - tools
      summary: available tools
      operationId: tools#available
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/ToolsToolResponseCollection'
      schemes:
      - http
  /v2/pkgs/tools/installed:
    get:
      tags:
      - tools
      summary: installed tools
      operationId: tools#installed
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/ToolsToolResponseCollection'
      schemes:
      - http
    post:
      tags:
      - tools
      summary: install tools
      operationId: tools#install
      parameters:
      - name: InstallRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/ToolsInstallRequestBody'
          required:
          - name
          - version
          - packager
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/ToolsInstallResponseBody'
      schemes:
      - http
  /v2/pkgs/tools/installed/{packager}/{name}/{version}:
    delete:
      tags:
      - tools
      summary: remove tools
      operationId: tools#remove
      parameters:
      - name: packager
        in: path
        description: The packager of the tool
        required: true
        type: string
      - name: name
        in: path
        description: The name of the tool
        required: true
        type: string
      - name: version
        in: path
        description: The version of the tool
        required: true
        type: string
      - name: RemoveRequestBody
        in: body
        required: true
        schema:
          $ref: '#/definitions/ToolsRemoveRequestBody'
      responses:
        "200":
          description: OK response.
          schema:
            $ref: '#/definitions/ToolsRemoveResponseBody'
      schemes:
      - http
definitions:
  IndexesAddRequestBody:
    title: IndexesAddRequestBody
    type: object
    properties:
      url:
        type: string
        description: The url of the index file
        example: http://downloads.arduino.cc/packages/package_index.json
    example:
      url: http://downloads.arduino.cc/packages/package_index.json
    required:
    - url
  IndexesAddResponseBody:
    title: 'Mediatype identifier: application/vnd.arduino.operation; view=default'
    type: object
    properties:
      status:
        type: string
        description: The status of the operation
        example: ok
    description: AddResponseBody result type (default view)
    example:
      status: ok
    required:
    - status
  IndexesRemoveRequestBody:
    title: IndexesRemoveRequestBody
    type: object
    properties:
      url:
        type: string
        description: The url of the index file
        example: http://downloads.arduino.cc/packages/package_index.json
    example:
      url: http://downloads.arduino.cc/packages/package_index.json
    required:
    - url
  IndexesRemoveResponseBody:
    title: 'Mediatype identifier: application/vnd.arduino.operation; view=default'
    type: object
    properties:
      status:
        type: string
        description: The status of the operation
        example: ok
    description: RemoveResponseBody result type (default view)
    example:
      status: ok
    required:
    - status
  Indexesadd_invalid_url_response_body:
    title: 'Mediatype identifier: application/vnd.goa.error; view=default'
    type: object
    properties:
      fault:
        type: boolean
        description: Is the error a server-side fault?
        example: false
      id:
        type: string
        description: ID is a unique identifier for this particular occurrence of the
          problem.
        example: 123abc
      message:
        type: string
        description: Message is a human-readable explanation specific to this occurrence
          of the problem.
        example: parameter 'p' must be an integer
      name:
        type: string
        description: Name is the name of this class of errors.
        example: bad_request
      temporary:
        type: boolean
        description: Is the error temporary?
        example: false
      timeout:
        type: boolean
        description: Is the error a timeout?
        example: false
    description: url invalid (default view)
    example:
      fault: true
      id: 123abc
      message: parameter 'p' must be an integer
      name: bad_request
      temporary: true
      timeout: true
    required:
    - name
    - id
    - message
    - temporary
    - timeout
    - fault
  Indexeslist_invalid_url_response_body:
    title: 'Mediatype identifier: application/vnd.goa.error; view=default'
    type: object
    properties:
      fault:
        type: boolean
        description: Is the error a server-side fault?
        example: true
      id:
        type: string
        description: ID is a unique identifier for this particular occurrence of the
          problem.
        example: 123abc
      message:
        type: string
        description: Message is a human-readable explanation specific to this occurrence
          of the problem.
        example: parameter 'p' must be an integer
      name:
        type: string
        description: Name is the name of this class of errors.
        example: bad_request
      temporary:
        type: boolean
        description: Is the error temporary?
        example: false
      timeout:
        type: boolean
        description: Is the error a timeout?
        example: false
    description: url invalid (default view)
    example:
      fault: false
      id: 123abc
      message: parameter 'p' must be an integer
      name: bad_request
      temporary: false
      timeout: false
    required:
    - name
    - id
    - message
    - temporary
    - timeout
    - fault
  Indexesremove_invalid_url_response_body:
    title: 'Mediatype identifier: application/vnd.goa.error; view=default'
    type: object
    properties:
      fault:
        type: boolean
        description: Is the error a server-side fault?
        example: false
      id:
        type: string
        description: ID is a unique identifier for this particular occurrence of the
          problem.
        example: 123abc
      message:
        type: string
        description: Message is a human-readable explanation specific to this occurrence
          of the problem.
        example: parameter 'p' must be an integer
      name:
        type: string
        description: Name is the name of this class of errors.
        example: bad_request
      temporary:
        type: boolean
        description: Is the error temporary?
        example: true
      timeout:
        type: boolean
        description: Is the error a timeout?
        example: true
    description: url invalid (default view)
    example:
      fault: false
      id: 123abc
      message: parameter 'p' must be an integer
      name: bad_request
      temporary: true
      timeout: false
    required:
    - name
    - id
    - message
    - temporary
    - timeout
    - fault
  ToolResponse:
    title: 'Mediatype identifier: application/vnd.arduino.tool; view=default'
    type: object
    properties:
      name:
        type: string
        description: The name of the tool
        example: avrdude
      packager:
        type: string
        description: The packager of the tool
        example: arduino
      version:
        type: string
        description: The version of the tool
        example: 6.3.0-arduino9
    description: A tool is an executable program that can upload sketches. (default
      view)
    example:
      name: avrdude
      packager: arduino
      version: 6.3.0-arduino9
    required:
    - name
    - version
    - packager
  ToolsInstallRequestBody:
    title: ToolsInstallRequestBody
    type: object
    properties:
      checksum:
        type: string
        description: "A checksum of the archive. Mandatory when url is present. \n\tThis
          ensures that the package is downloaded correcly."
        example: Occaecati eum.
      name:
        type: string
        description: The name of the tool
        example: avrdude
      packager:
        type: string
        description: The packager of the tool
        example: arduino
      url:
        type: string
        description: "The url where the package can be found. Optional. \n\tIf present
          checksum must also be present."
        example: Sit quod dolor repellat.
      version:
        type: string
        description: The version of the tool
        example: 6.3.0-arduino9
    example:
      checksum: Id ut totam.
      name: avrdude
      packager: arduino
      url: Vero ipsum corporis nihil.
      version: 6.3.0-arduino9
    required:
    - name
    - version
    - packager
  ToolsInstallResponseBody:
    title: 'Mediatype identifier: application/vnd.arduino.operation; view=default'
    type: object
    properties:
      status:
        type: string
        description: The status of the operation
        example: ok
    description: InstallResponseBody result type (default view)
    example:
      status: ok
    required:
    - status
  ToolsRemoveRequestBody:
    title: ToolsRemoveRequestBody
    type: object
    properties:
      checksum:
        type: string
        description: "A checksum of the archive. Mandatory when url is present. \n\tThis
          ensures that the package is downloaded correcly."
        example: Nobis officia optio inventore.
      url:
        type: string
        description: "The url where the package can be found. Optional. \n\tIf present
          checksum must also be present."
        example: Inventore exercitationem.
    example:
      checksum: Qui modi dolorem.
      url: In voluptatibus.
  ToolsRemoveResponseBody:
    title: 'Mediatype identifier: application/vnd.arduino.operation; view=default'
    type: object
    properties:
      status:
        type: string
        description: The status of the operation
        example: ok
    description: RemoveResponseBody result type (default view)
    example:
      status: ok
    required:
    - status
  ToolsToolResponseCollection:
    title: 'Mediatype identifier: application/vnd.arduino.tool; type=collection; view=default'
    type: array
    items:
      $ref: '#/definitions/ToolResponse'
    description: AvailableResponseBody is the result type for an array of ToolResponse
      (default view)
    example:
    - name: avrdude
      packager: arduino
      version: 6.3.0-arduino9
    - name: avrdude
      packager: arduino
      version: 6.3.0-arduino9
    - name: avrdude
      packager: arduino
      version: 6.3.0-arduino9
    - name: avrdude
      packager: arduino
      version: 6.3.0-arduino9