swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Reviews Public API API
schemes:
- https
tags:
- name: Reviews Public API
paths:
  /products/{uniqueProductId}/reviews/{reviewId}/comments:
    get:
      tags:
      - Reviews Public API
      summary: Microsoft Azure Get The Comments Of A Given Review
      operationId: microsoftAzureCommentsGet
      x-ms-examples:
        GetComments:
          $ref: ./examples/GetReviewComments.json
      produces:
      - application/json
      parameters:
      - type: string
        name: uniqueProductId
        in: path
        required: true
        description: Unique Product Id
      - type: string
        name: reviewId
        in: path
        required: true
        description: Review Id
      - type: integer
        name: maxpagesize
        in: query
        description: maximum number of comments to return
        format: int32
        default: 50
      - type: string
        name: api-version
        in: query
        required: true
        description: Version of the REST API used for the request.
      - type: string
        name: X-API-Key
        in: header
        required: true
        description: Api Key parameter from header
      responses:
        '200':
          description: Returns a list of comments for the given review
          schema:
            $ref: '#/definitions/PageResultOfReviewCommentDto'
        default:
          description: "*** Error Responses: ***\n\n * 400 - In case request malformed.\n\n * 500 - In case internal error."
          schema:
            $ref: '#/definitions/ErrorResponse'
      description: Needs a more full description created.
definitions:
  ErrorResponseDetails:
    description: The Rating and Reviews error response details object
    type: object
    required:
    - code
    - message
    properties:
      code:
        description: The error code description. Such as code=InternalError
        type: string
      message:
        description: The error message. Such as message=Internal server error
        type: string
  ErrorResponse:
    description: The Rating and Reviews error response object
    type: object
    required:
    - error
    properties:
      error:
        description: The search error response details
        $ref: '#/definitions/ErrorResponseDetails'
  ReviewCommentDto:
    type: object
    required:
    - createdDateTime
    - lastModifiedDateTime
    - deleted
    properties:
      id:
        type: string
        description: Comment Id
      content:
        type: string
        description: Comment Content
      createdDateTime:
        type: string
        description: Created Date
        format: date-time
      lastModifiedDateTime:
        type: string
        description: Last Updated Date
        format: date-time
      commenterName:
        type: string
        description: Commenter Full Name
      deleted:
        type: boolean
        description: Is Deleted. If true all other properties will be empty
  PageResultOfReviewCommentDto:
    type: object
    required:
    - count
    properties:
      value:
        type: array
        description: List of items in the current page
        items:
          $ref: '#/definitions/ReviewCommentDto'
      count:
        type: integer
        description: Total count of items
        format: int32
      nextLink:
        type: string
        description: Url to get the next page of items
        format: uri
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'