summaryrefslogtreecommitdiffstats
path: root/fatcat-openapi2.yml
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-09-18 11:12:47 -0700
committerBryan Newbold <bnewbold@robocracy.org>2018-12-26 23:32:43 -0800
commit2842422bb04d176b7f41888e6eed10cd4b81bbac (patch)
tree10cbcc3e8a512117c1afd8732c6d49b90ef97f02 /fatcat-openapi2.yml
parent0f7fb8806c1a39aa54d0cd051aa48478c1b1c070 (diff)
downloadfatcat-2842422bb04d176b7f41888e6eed10cd4b81bbac.tar.gz
fatcat-2842422bb04d176b7f41888e6eed10cd4b81bbac.zip
first attempt at auth in API spec
Diffstat (limited to 'fatcat-openapi2.yml')
-rw-r--r--fatcat-openapi2.yml37
1 files changed, 37 insertions, 0 deletions
diff --git a/fatcat-openapi2.yml b/fatcat-openapi2.yml
index 0f52a8b6..713cb116 100644
--- a/fatcat-openapi2.yml
+++ b/fatcat-openapi2.yml
@@ -13,6 +13,12 @@ consumes:
produces:
- application/json
+securityDefinitions:
+ Bearer:
+ type: apiKey
+ name: Authorization
+ in: header
+
tags: # TAGLINE
- name: containers # TAGLINE
descriptions: "Container entities: such as journals, conferences, book series" # TAGLINE
@@ -548,6 +554,13 @@ x-entity-responses: &ENTITYRESPONSES
description: Bad Request
schema:
$ref: "#/definitions/error_response"
+ 401:
+ description: Not Authorized # "Authentication information is missing or invalid"
+ schema:
+ $ref: "#/definitions/error_response"
+ headers:
+ WWW_Authenticate:
+ type: string
404:
description: Not Found
schema:
@@ -573,6 +586,8 @@ paths:
in: query
required: false
type: string
+ security:
+ - Bearer: []
responses:
201:
description: Created Entity
@@ -602,6 +617,8 @@ paths:
type: array
items:
$ref: "#/definitions/container_entity"
+ security:
+ - Bearer: []
responses:
201:
description: Created Entities
@@ -651,6 +668,8 @@ paths:
in: query
required: false
type: string
+ security:
+ - Bearer: []
responses:
200:
description: Updated Entity
@@ -666,6 +685,8 @@ paths:
in: query
required: false
type: string
+ security:
+ - Bearer: []
responses:
200:
description: Deleted Entity
@@ -816,6 +837,8 @@ paths:
in: query
required: false
type: string
+ security:
+ - Bearer: []
responses:
201:
description: Created Entity
@@ -845,6 +868,8 @@ paths:
type: array
items:
$ref: "#/definitions/creator_entity"
+ security:
+ - Bearer: []
responses:
201:
description: Created Entities
@@ -894,6 +919,8 @@ paths:
in: query
required: false
type: string
+ security:
+ - Bearer: []
responses:
200:
description: Updated Entity
@@ -909,6 +936,8 @@ paths:
in: query
required: false
type: string
+ security:
+ - Bearer: []
responses:
200:
description: Deleted Entity
@@ -1082,6 +1111,8 @@ paths:
in: query
required: false
type: string
+ security:
+ - Bearer: []
responses:
201:
description: Created Entity
@@ -1111,6 +1142,8 @@ paths:
type: array
items:
$ref: "#/definitions/file_entity"
+ security:
+ - Bearer: []
responses:
201:
description: Created Entities
@@ -1160,6 +1193,8 @@ paths:
in: query
required: false
type: string
+ security:
+ - Bearer: []
responses:
200:
description: Updated Entity
@@ -1175,6 +1210,8 @@ paths:
in: query
required: false
type: string
+ security:
+ - Bearer: []
responses:
200:
description: Deleted Entity