Made fields for edit nullable
This commit is contained in:
100
api.yaml
100
api.yaml
@@ -154,7 +154,37 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
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:
|
security:
|
||||||
- cookie: []
|
- cookie: []
|
||||||
responses:
|
responses:
|
||||||
@@ -182,7 +212,41 @@ paths:
|
|||||||
id:
|
id:
|
||||||
type: number
|
type: number
|
||||||
description: Id of the article to edit
|
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:
|
security:
|
||||||
- cookie: []
|
- cookie: []
|
||||||
responses:
|
responses:
|
||||||
@@ -257,38 +321,6 @@ components:
|
|||||||
message:
|
message:
|
||||||
type: string
|
type: string
|
||||||
description: Error message
|
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:
|
ArticleSummary:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
Reference in New Issue
Block a user