diff options
Diffstat (limited to 'openapi/fortee.yaml')
| -rw-r--r-- | openapi/fortee.yaml | 52 |
1 files changed, 23 insertions, 29 deletions
diff --git a/openapi/fortee.yaml b/openapi/fortee.yaml index 7e27f30..89a1842 100644 --- a/openapi/fortee.yaml +++ b/openapi/fortee.yaml @@ -2,30 +2,15 @@ openapi: 3.0.0 info: title: fortee API version: 0.1.0 +tags: [] paths: /api/user/login: post: operationId: postLogin - summary: User login - requestBody: - required: true - content: - application/x-www-form-urlencoded: - schema: - type: object - properties: - username: - type: string - example: "john" - password: - type: string - example: "password123" - required: - - username - - password + parameters: [] responses: '200': - description: Successfully authenticated + description: The request has succeeded. content: application/json: schema: @@ -33,30 +18,41 @@ paths: properties: loggedIn: type: boolean - example: true user: type: object properties: username: type: string - example: "john" required: - username required: - loggedIn + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + username: + type: string + password: + type: string + required: + - username + - password /api/user/view/{username}: get: operationId: getUser - summary: Get a user parameters: - - in: path - name: username + - name: username + in: path + required: true schema: type: string - required: true responses: '200': - description: User found + description: The request has succeeded. content: application/json: schema: @@ -64,16 +60,14 @@ paths: properties: uuid: type: string - example: "11111111-1111-1111-1111-111111111111" username: type: string - example: "john" avatar_url: type: string - example: "/files/_user/11111111-1111-1111-1111-111111111111.jpg" required: - uuid - username - avatar_url '404': - description: User not found + description: The server cannot find the requested resource. +components: {} |