openapi: 3.1.0
info:
  title: TSS Rocks API
  description: |
    TSS Rocks REST API
  version: 0.1.0
  contact:
    name: STARSET Mirror
    url: 'https://mirror.starset.fans/about'
servers:
  - url: 'https://tss.rocks/api/v1'
    description: API v1 endpoints
security:
  - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  parameters:
    Page:
      $ref: './components/parameters.yaml#/Page'
    PerPage:
      $ref: './components/parameters.yaml#/PerPage'
    Language:
      $ref: './components/parameters.yaml#/Language'
    Sort:
      $ref: './components/parameters.yaml#/Sort'
    Status:
      $ref: './components/parameters.yaml#/Status'
    Id:
      $ref: './components/parameters.yaml#/Id'
    Slug:
      $ref: './components/parameters.yaml#/Slug'
  responses:
    Unauthorized:
      $ref: './components/responses.yaml#/Unauthorized'
    Forbidden:
      $ref: './components/responses.yaml#/Forbidden'
    NotFound:
      $ref: './components/responses.yaml#/NotFound'
    ValidationError:
      $ref: './components/responses.yaml#/ValidationError'
    TooManyRequests:
      $ref: './components/responses.yaml#/TooManyRequests'
    InternalError:
      $ref: './components/responses.yaml#/InternalError'
  schemas:
    Response:
      $ref: './components/schemas.yaml#/Response'
    Error:
      $ref: './components/schemas.yaml#/Error'
    User:
      $ref: './components/schemas.yaml#/User'
    Post:
      $ref: './components/schemas.yaml#/Post'
    PostContent:
      $ref: './components/schemas.yaml#/PostContent'
    Category:
      $ref: './components/schemas.yaml#/Category'
    CategoryContent:
      $ref: './components/schemas.yaml#/CategoryContent'
    Contributor:
      $ref: './components/schemas.yaml#/Contributor'
    Media:
      $ref: './components/schemas.yaml#/Media'
    DailyCategory:
      $ref: './components/schemas.yaml#/DailyCategory'
    Daily:
      $ref: './components/schemas.yaml#/Daily'
paths:
  /auth/login:
    $ref: './paths/auth.yaml#/login'
  /auth/logout:
    $ref: './paths/auth.yaml#/logout'
  /posts:
    $ref: './paths/posts.yaml#/posts'
  '/posts/{slug}':
    $ref: './paths/posts.yaml#/post_slug'
  '/posts/{slug}/contributors':
    $ref: './paths/posts.yaml#/post_contributors'
  /categories:
    $ref: './paths/categories.yaml#/categories'
  '/categories/{slug}':
    $ref: './paths/categories.yaml#/category_slug'
  '/categories/{slug}/posts':
    $ref: './paths/categories.yaml#/category_posts'
  /contributors:
    $ref: './paths/contributors.yaml#/contributors'
  '/contributors/{id}':
    $ref: './paths/contributors.yaml#/contributor_id'
  '/contributors/{id}/posts':
    $ref: './paths/contributors.yaml#/contributor_posts'
  /users:
    $ref: './paths/users.yaml#/users'
  '/users/{id}':
    $ref: './paths/users.yaml#/user_id'
  /users/me:
    $ref: './paths/users.yaml#/user_me'
  /media:
    $ref: './paths/media.yaml#/media'
  '/media/{id}':
    $ref: './paths/media.yaml#/media_id'
  /daily:
    $ref: './paths/daily.yaml#/daily'
  '/daily/{id}':
    $ref: './paths/daily.yaml#/daily_id'
tags:
  - name: auth
    description: 认证相关接口
  - name: posts
    description: 文章管理接口
  - name: categories
    description: 分类管理接口
  - name: contributors
    description: 贡献者管理接口
  - name: media
    description: 媒体文件管理接口
  - name: daily
    description: 每日一图管理接口
  - name: users
    description: 用户管理接口