Skip to content

Commit

Permalink
update openapi.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
catnose99 committed Mar 8, 2024
1 parent 9e45e40 commit 952315f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5,671 deletions.
23 changes: 20 additions & 3 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,15 @@ paths:
enum: ["asc", "desc"]
- in: query
name: visibility
description: 記事の公開範囲
description: |-
記事の公開範囲
* `MYSELF`: 自分だけ(非公開)
* `ANYONE`: みんな(公開)
* `URL_ONLY`: URLを知っている人だけ(URL限定公開)
schema:
type: string
enum: ["MYSELF", "ANYONE"]
enum: ["MYSELF", "ANYONE", "URL_ONLY"]
- in: query
name: createdAfter
description: 指定日時以降に作成された記事を取得。ISO 8601形式で指定する。
Expand Down Expand Up @@ -190,21 +195,31 @@ components:
type: string
title:
type: string
description: 記事のタイトル
bodyCharacterCount:
type: integer
description: 本文の文字数
visibility:
type: string
enum: ["MYSELF", "ANYONE"]
enum: ["MYSELF", "ANYONE", "URL_ONLY"]
description: |-
記事の公開範囲
* `MYSELF`: 自分だけ(非公開)
* `ANYONE`: みんな(公開)
* `URL_ONLY`: URLを知っている人だけ(URL限定公開)
tags:
type: array
items:
type: string
createdAt:
type: string
format: date-time
description: 記事の作成日
updatedAt:
type: string
format: date-time
description: 記事の更新日
PostDetail:
allOf:
- $ref: "#/components/schemas/PostMeta"
Expand All @@ -213,9 +228,11 @@ components:
bodyMarkdown:
type: string
nullable: true
description: 本文のMarkdown
bodyHtml:
type: string
nullable: true
description: 本文のHTML
Pagination:
type: object
properties:
Expand Down
Loading

0 comments on commit 952315f

Please sign in to comment.