-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: May be slightly off, added new user and status endpoints.
- Loading branch information
Showing
12 changed files
with
183 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
154 changes: 154 additions & 0 deletions
154
Writerside/topics/flyte/flyteapi/endpoints/openapi.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,154 @@ | ||
openapi: 3.0.1 | ||
info: | ||
title: Flyte API | ||
description: API description in Markdown. | ||
version: 0.0.1 | ||
servers: | ||
- url: 'https://api.flyte.gg/v1' | ||
paths: | ||
/users/{user-id}: | ||
get: | ||
summary: Get user by ID | ||
description: Get user by ID | ||
parameters: | ||
- name: user-id | ||
in: path | ||
description: ID of user to return | ||
required: true | ||
schema: | ||
type: string | ||
responses: | ||
'200': | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/User' | ||
'401': | ||
description: Unauthorized | ||
post: | ||
summary: Update user | ||
description: Update user | ||
parameters: | ||
- name: user-id | ||
in: path | ||
description: ID of user to return | ||
required: true | ||
schema: | ||
type: string | ||
requestBody: | ||
required: true | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/User' | ||
responses: | ||
'201': | ||
description: Created | ||
'401': | ||
description: Unauthorized | ||
patch: | ||
summary: Update user | ||
description: Update user | ||
parameters: | ||
- name: user-id | ||
in: path | ||
description: ID of user to return | ||
required: true | ||
schema: | ||
type: string | ||
requestBody: | ||
required: true | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/User' | ||
responses: | ||
'202': | ||
description: Accepted | ||
'401': | ||
description: Unauthorized | ||
delete: | ||
summary: Delete user | ||
description: Delete user | ||
parameters: | ||
- name: user-id | ||
in: path | ||
description: ID of user to return | ||
required: true | ||
schema: | ||
type: string | ||
responses: | ||
'202': | ||
description: Accepted | ||
'401': | ||
description: Unauthorized | ||
|
||
/status: | ||
get: | ||
summary: View status of all Flyte services. | ||
description: View status of all Flyte services in one endpoint. | ||
responses: | ||
'200': | ||
description: OK (Returns Array of Objects) | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/StatusCheck' | ||
'401': | ||
description: Unauthorized | ||
|
||
post: | ||
summary: Update status of a Flyte service. | ||
description: Update status of a Flyte service. | ||
requestBody: | ||
required: true | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/StatusCheck' | ||
|
||
responses: | ||
'201': | ||
description: Created | ||
'401': | ||
description: Unauthorized | ||
|
||
components: | ||
schemas: | ||
User: | ||
type: object | ||
properties: | ||
id: | ||
type: number | ||
role: | ||
type: string | ||
accountType: | ||
type: string | ||
involvedProjects: | ||
type: object # HashMap<String, String> | ||
additionalProperties: | ||
type: string | ||
|
||
|
||
StatusCheck: | ||
type: array | ||
properties: | ||
id: | ||
type: string | ||
name: | ||
type: string | ||
healthy: | ||
type: boolean | ||
|
||
|
||
securitySchemes: | ||
bearerAuth: | ||
type: http | ||
scheme: bearer | ||
bearerFormat: JWT | ||
|
||
security: | ||
- bearerAuth: [ ] | ||
|
||
|
3 changes: 3 additions & 0 deletions
3
Writerside/topics/flyte/flyteapi/endpoints/status/Get-Flyte-Services-Status.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Get Status of Flyte Services | ||
|
||
<api-endpoint openapi-path="../openapi.yaml" endpoint="/status" method="get"/> |
4 changes: 0 additions & 4 deletions
4
Writerside/topics/flyte/flyteapi/endpoints/status/Get-Flyte-Status.md
This file was deleted.
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
Writerside/topics/flyte/flyteapi/endpoints/status/Update-Service.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Update Status of Flyte Services | ||
|
||
<api-endpoint openapi-path="../openapi.yaml" endpoint="/status" method="post"/> |
86 changes: 0 additions & 86 deletions
86
Writerside/topics/flyte/flyteapi/endpoints/status/openapi.yaml
This file was deleted.
Oops, something went wrong.
4 changes: 4 additions & 0 deletions
4
Writerside/topics/flyte/flyteapi/endpoints/users/Delete-User.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Delete User By Id | ||
|
||
<api-endpoint openapi-path="../openapi.yaml" endpoint="/users/{user-id}" method="delete"/> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Get User By ID | ||
|
||
<api-endpoint openapi-path="../openapi.yaml" endpoint="/users/{user-id}" method="get"/> |
4 changes: 4 additions & 0 deletions
4
Writerside/topics/flyte/flyteapi/endpoints/users/Patch-User.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Modify User By Id | ||
|
||
<api-endpoint openapi-path="../openapi.yaml" endpoint="/users/{user-id}" method="patch"/> | ||
|
4 changes: 4 additions & 0 deletions
4
Writerside/topics/flyte/flyteapi/endpoints/users/Post-User.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Update User By ID | ||
|
||
<api-endpoint openapi-path="../openapi.yaml" endpoint="/users/{user-id}" method="post"/> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters