TheAdversary/api
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Made fields for edit nullable

Browse Source
This commit is contained in:
Ruben Otto
2022-01-23 00:17:43 +01:00
parent 5445cc2de2
commit 40662f31fd
1 changed files with 66 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
api.yaml
View File

@@ -154,7 +154,37 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/Article'
type: object
properties:
title:
type: string
description: "Name of the article. Must be unique"
summary:
type: string
description: A short overview summary of the article
authors:
type: array
items:
type: number
description: A author id
description: List of additional authors as id which contributed to the article. The author which sends this request is automatically added as (main) author
image:
type: string
description: Link to a preview image
nullable: true
tags:
type: array
items:
type: number
description: A tag id
description: Tags as id the article should have. If the tag does not exist, a new one is created automatically
link:
type: string
description: The link name (last path of the url) which redirects to the article
nullable: true
content:
type: string
description: The article itself, formatted as markdown. Must be encoded as base64
security:
- cookie: []
responses:
@@ -182,7 +212,41 @@ paths:
id:
type: number
description: Id of the article to edit
$ref: '#/components/schemas/Article'
title:
type: string
description: "Name of the article. Must be unique"
nullable: true
summary:
type: string
description: A short overview summary of the article
nullable: true
authors:
type: array
items:
type: number
description: A author id
description: List of additional authors as id which contributed to the article. The author which sends this request is automatically added as (main) author
nullable: true
image:
type: string
description: Link to a preview image
nullable: true
tags:
type: array
items:
type: number
description: A tag id
description: Tags as id the article should have. If the tag does not exist, a new one is created automatically
nullable: true
link:
type: string
description: The link name (last path of the url) which redirects to the article
nullable: true
content:
type: string
description: The article itself, formatted as markdown. Must be encoded as base64
nullable: true
security:
- cookie: []
responses:
@@ -257,38 +321,6 @@ components:
message:
type: string
description: Error message
Article:
type: object
properties:
title:
type: string
description: "Name of the article. Must be unique"
summary:
type: string
description: A short overview summary of the article
authors:
type: array
items:
type: number
description: A author id
description: List of additional authors as id which contributed to the article. The author which sends this request is automatically added as (main) author
image:
type: string
description: Link to a preview image
nullable: true
tags:
type: array
items:
type: number
description: A tag id
description: Tags as id the article should have. If the tag does not exist, a new one is created automatically
link:
type: string
description: The link name (last path of the url) which redirects to the article
nullable: true
content:
type: string
description: The article itself, formatted as markdown. Must be encoded as base64
ArticleSummary:
type: object
properties: