YAML OpenAPI 3 Specification
API specification
info:
version: '1.0.0'
paths:
/articles/{articleId}/comments/:
get:
description: Returns a list of comments along with user details for display.
parameters:
- name: articleId
in: path
required: true
schema:
type: string
- name: limit
in: query
required: false
type: integer
default: 10
- name: offset
required: false schema:
default: 0
responses:
'200':
content:
application/json:
type: object
properties:
comments:
type: array
items:
commentId:
text:
timestamp:
format: date-time
user:
properties: userId:
name:
profilePicture:
format: uri
'400':
error:
'404':
type: string components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
security:
- ApiKeyAuth: []
