fix: some definitions in read API spec

v1.18.x
Julian Lam 5 years ago
parent ac98775f23
commit 03739b6f83

@ -8,6 +8,10 @@ info:
# Introduction # Introduction
The following document outlines every Read API route available via NodeBB. Unlike the write API, the v1.x API was coded organically, and is **not** strictly RESTful. These shortcomings will be addressed in the v2.x version of the API. The following document outlines every Read API route available via NodeBB. Unlike the write API, the v1.x API was coded organically, and is **not** strictly RESTful. These shortcomings will be addressed in the v2.x version of the API.
## Authentication
Authentication with this API is done via cookies. A valid login session is required for API calls that pertain to operations involving a logged-in user. For example, `/api/unread` is a route showing unread topics, and is not accessible by guest users.
tags: tags:
- name: home - name: home
description: Routes used at the forum index only description: Routes used at the forum index only
@ -38,6 +42,8 @@ paths:
get: get:
tags: tags:
- home - home
description: |
This route is used to populate the homepage of NodeBB. It is the main access point of the forum, and shows a list of categories for navigation purposes.
summary: /api/ summary: /api/
responses: responses:
"200": "200":
@ -599,19 +605,6 @@ paths:
- index - index
- teaserPid - teaserPid
- thumb - thumb
recentCards:
type: object
properties:
title:
type: string
opacity:
type: string
textShadow:
type: string
enableCarousel:
type: number
enableCarouselPagination:
type: number
_header: _header:
type: object type: object
properties: properties:
@ -701,8 +694,19 @@ paths:
in: path in: path
required: true required: true
schema: schema:
type: number
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
properties:
pid:
type: number
content:
type: string type: string
responses: {}
/api/admin: /api/admin:
get: get:
tags: tags:

Loading…
Cancel
Save