Files
NodeBB/public/openapi/write/posts/pid/summary.yaml

35 lines
889 B
YAML

get:
tags:
- posts
summary: get post summary
description: |
This operation retrieves a post full summary.
This differs from the "get a post" call in that it will return the following additional information:
* A minimal user object
* A topic object
* A category object
* Post content is run through the parser
parameters:
- in: path
name: pid
schema:
type: string
required: true
description: a valid post id
example: 2
responses:
'200':
description: Post summary successfully retrieved.
content:
application/json:
schema:
type: object
properties:
status:
$ref: ../../../components/schemas/Status.yaml#/Status
response:
$ref: ../../../components/schemas/PostObject.yaml#/PostObject