added profile module

This commit is contained in:
Roland Osborne 2021-12-21 14:47:10 -08:00
parent 4248594629
commit d8c058dbcf

125
api.oa3
View File

@ -312,6 +312,43 @@ paths:
'500': '500':
description: internal server error description: internal server error
/account/authentication:
post:
tags:
- account
description: Generate token to reset authentication
operationId: add-account-authentication
security:
- basicAuth: []
responses:
'201':
description: generated
content:
application/json:
schema:
type: string
'401':
description: invalid password
'500':
description: internal server error
put:
tags:
- account
description: Apply account reset token to set handle and password
operationId: set-account-authentication
security:
- bearerAuth: []
- basicAuth: []
responses:
'201':
description: successful operation
'401':
description: invalid token
'406':
description: invalid handle or password
'500':
description: internal server error
/account/attachment: /account/attachment:
post: post:
tags: tags:
@ -447,7 +484,7 @@ paths:
tags: tags:
- registry - registry
description: Get list of publically searchable profiles description: Get list of publically searchable profiles
operationId: get-public-profiles operationId: get-registry-profiles
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -469,7 +506,7 @@ paths:
tags: tags:
- registry - registry
description: Get public profile of specified account description: Get public profile of specified account
operationId: get-profile-image operationId: get-registry-profile-image
parameters: parameters:
- name: guid - name: guid
in: path in: path
@ -497,7 +534,7 @@ paths:
tags: tags:
- registry - registry
description: Get public profile of specified account description: Get public profile of specified account
operationId: get-profile-message operationId: get-registry-profile-message
parameters: parameters:
- name: guid - name: guid
in: path in: path
@ -546,6 +583,63 @@ paths:
'500': '500':
description: internal server error description: internal server error
/profile:
get:
tags:
- profile
description: Get profile view object
operationId: get-profile
security:
- bearerAuth: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileView'
'401':
description: invalid token
'500':
description: internal server error
put:
tags:
- profile
description: Set profile data
operationId: set-profile
security:
- bearerAuth: []
responses:
'200':
description: successful operation
'401':
description: invalid token
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileData'
/profile/message:
get:
tags:
- profile
description: Get profile message
operationId: get-profile-message
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DataMessage'
'401':
description: invalid token
'500':
description: internal server error
externalDocs: externalDocs:
description: Find out more about Swagger description: Find out more about Swagger
url: 'http://swagger.io' url: 'http://swagger.io'
@ -598,15 +692,19 @@ components:
type: object type: object
required: required:
- guid - guid
- profileData
- image
- revision - revision
- node - node
properties: properties:
guid: guid:
type: string type: string
profileData: handle:
$ref: '#/components/schemas/ProfileData' type: string
name:
type: string
description:
type: string
location:
type: string
image: image:
type: string type: string
format: base64 encoded data format: base64 encoded data
@ -627,19 +725,26 @@ components:
type: string type: string
location: location:
type: string type: string
image:
type: string
ProfileView: ProfileView:
type: object type: object
required: required:
- guid - guid
- profileData
- imageSet - imageSet
- revision - revision
properties: properties:
guid: guid:
type: string type: string
profileData: handle:
$ref: '#/components/schemas/ProfileData' type: string
name:
type: string
description:
type: string
location:
type: string
imageSet: imageSet:
type: boolean type: boolean
revision: revision: