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

put:
  tags:
    - posts
  summary: edit a post
  description: This operation edits a post
  parameters:
    - in: path
      name: pid
      schema:
        type: string
      required: true
      description: a valid post id
      example: 1
  requestBody:
    required: true
    content:
      application/json:
        schema:
          type: object
          properties:
            content:
              type: string
              description: New post content
              example: New post content
            title:
              type: string
              description: Topic title, only accepted for main posts
              example: New title
          required:
            - content
  responses:
    '200':
      description: Post successfully edited
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                $ref: ../../components/schemas/Status.yaml#/Status
              response:
                $ref: ../../components/schemas/PostObject.yaml#/PostObject
delete:
  tags:
    - posts
  summary: purge a post
  description: This operation purges a post.
  parameters:
    - in: path
      name: pid
      schema:
        type: string
      required: true
      description: a valid post id
      example: 1
  responses:
    '200':
      description: Post successfully purged
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                $ref: ../../components/schemas/Status.yaml#/Status
              response:
                type: object
                properties: {}