diff --git a/Writerside/flyte.tree b/Writerside/flyte.tree index 57aee6a..1f073e3 100644 --- a/Writerside/flyte.tree +++ b/Writerside/flyte.tree @@ -15,10 +15,15 @@ + + + + - + + diff --git a/Writerside/topics/Home.md b/Writerside/topics/Home.md index 601e09d..2a5ae78 100644 --- a/Writerside/topics/Home.md +++ b/Writerside/topics/Home.md @@ -20,7 +20,7 @@ You will find all the topics in the left sidebar. These topics are organized in Documentation has been deployed publicly -Flyte /status Endpoints Added +Flyte /status Endpoints Added
  • added the status field
  • diff --git a/Writerside/topics/flyte/flyteapi/endpoints/openapi.yaml b/Writerside/topics/flyte/flyteapi/endpoints/openapi.yaml new file mode 100644 index 0000000..669c723 --- /dev/null +++ b/Writerside/topics/flyte/flyteapi/endpoints/openapi.yaml @@ -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 + 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: [ ] + + diff --git a/Writerside/topics/flyte/flyteapi/endpoints/status/Get-Flyte-Services-Status.md b/Writerside/topics/flyte/flyteapi/endpoints/status/Get-Flyte-Services-Status.md new file mode 100644 index 0000000..34a95e8 --- /dev/null +++ b/Writerside/topics/flyte/flyteapi/endpoints/status/Get-Flyte-Services-Status.md @@ -0,0 +1,3 @@ +# Get Status of Flyte Services + + diff --git a/Writerside/topics/flyte/flyteapi/endpoints/status/Get-Flyte-Status.md b/Writerside/topics/flyte/flyteapi/endpoints/status/Get-Flyte-Status.md deleted file mode 100644 index 77cbe3b..0000000 --- a/Writerside/topics/flyte/flyteapi/endpoints/status/Get-Flyte-Status.md +++ /dev/null @@ -1,4 +0,0 @@ -# Manage Flyte Service Status - - - diff --git a/Writerside/topics/flyte/flyteapi/endpoints/status/Update-Service.md b/Writerside/topics/flyte/flyteapi/endpoints/status/Update-Service.md new file mode 100644 index 0000000..f644280 --- /dev/null +++ b/Writerside/topics/flyte/flyteapi/endpoints/status/Update-Service.md @@ -0,0 +1,3 @@ +# Update Status of Flyte Services + + diff --git a/Writerside/topics/flyte/flyteapi/endpoints/status/openapi.yaml b/Writerside/topics/flyte/flyteapi/endpoints/status/openapi.yaml deleted file mode 100644 index 4661005..0000000 --- a/Writerside/topics/flyte/flyteapi/endpoints/status/openapi.yaml +++ /dev/null @@ -1,86 +0,0 @@ -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: - /status: - get: - summary: View status of all Flyte services. - description: View status of all Flyte services in one endpoint. - responses: - '200': - description: OK - 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/IndividualStatus' - - responses: - '201': - description: Created - '401': - description: Unauthorized - -components: - schemas: - IndividualStatus: - type: object - properties: - id: - type: string - name: - type: string - healthy: - type: boolean - - StatusCheck: - type: object - properties: - healthy: - type: boolean - dependencies: - type: array - items: - type: object - properties: - id: - type: string - name: - type: string - healthy: - type: boolean - - UnauthorizedError: - type: object - properties: - message: - type: string - documentation_url: - type: string - - - securitySchemes: - bearerAuth: - type: http - scheme: bearer - bearerFormat: JWT - -security: - - bearerAuth: [ ] - - diff --git a/Writerside/topics/flyte/flyteapi/endpoints/users/Delete-User.md b/Writerside/topics/flyte/flyteapi/endpoints/users/Delete-User.md new file mode 100644 index 0000000..7867eb4 --- /dev/null +++ b/Writerside/topics/flyte/flyteapi/endpoints/users/Delete-User.md @@ -0,0 +1,4 @@ +# Delete User By Id + + + diff --git a/Writerside/topics/flyte/flyteapi/endpoints/users/Get-User.md b/Writerside/topics/flyte/flyteapi/endpoints/users/Get-User.md new file mode 100644 index 0000000..bf65985 --- /dev/null +++ b/Writerside/topics/flyte/flyteapi/endpoints/users/Get-User.md @@ -0,0 +1,3 @@ +# Get User By ID + + diff --git a/Writerside/topics/flyte/flyteapi/endpoints/users/Patch-User.md b/Writerside/topics/flyte/flyteapi/endpoints/users/Patch-User.md new file mode 100644 index 0000000..421f43e --- /dev/null +++ b/Writerside/topics/flyte/flyteapi/endpoints/users/Patch-User.md @@ -0,0 +1,4 @@ +# Modify User By Id + + + diff --git a/Writerside/topics/flyte/flyteapi/endpoints/users/Post-User.md b/Writerside/topics/flyte/flyteapi/endpoints/users/Post-User.md new file mode 100644 index 0000000..3d1bdd7 --- /dev/null +++ b/Writerside/topics/flyte/flyteapi/endpoints/users/Post-User.md @@ -0,0 +1,4 @@ +# Update User By ID + + + diff --git a/Writerside/topics/flyte/other/scripts/Ptero-Build-Flow.md b/Writerside/topics/flyte/other/scripts/Ptero-Build-Flow.md index 028afc5..9256abd 100644 --- a/Writerside/topics/flyte/other/scripts/Ptero-Build-Flow.md +++ b/Writerside/topics/flyte/other/scripts/Ptero-Build-Flow.md @@ -24,6 +24,7 @@ shadowJar { #### For Maven To do this with maven, you can add this to your build inside pom.xml + ```xml example