From 1c526b104762427617f076e6722ac76cbd667f79 Mon Sep 17 00:00:00 2001 From: archeoss Date: Fri, 2 Feb 2024 05:13:15 +0000 Subject: [PATCH] Autogenerate API --- api/openapi.yaml | 781 +++++++++++++++++++++++++++++++---------------- 1 file changed, 524 insertions(+), 257 deletions(-) diff --git a/api/openapi.yaml b/api/openapi.yaml index ebcc52a0..3f3e594c 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -5,31 +5,31 @@ info: contact: name: Romanov Simeon ArchArcheoss@proton.me license: - name: "" + name: '' version: 0.0.0 paths: /api/v1/disks/count: get: tags: - - services::api + - services::api summary: Returns count of Physical Disks per status description: Returns count of Physical Disks per status operationId: get_disks_count responses: - "200": + '200': description: Returns a list with count of physical disks per status content: application/json: schema: - $ref: "#/components/schemas/DiskCount" - "401": + $ref: '#/components/schemas/DiskCount' + '401': description: Unauthorized security: - - api_key: [] + - api_key: [] /api/v1/login: post: tags: - - services::auth + - services::auth summary: Login to a BOB cluster description: | Login to a BOB cluster @@ -47,123 +47,224 @@ paths: The client couldn't authorize on the host operationId: login parameters: - - name: hostname - in: path - description: Address to connect to - required: true - schema: - $ref: "#/components/schemas/Hostname" - - name: credentials - in: path - description: "[Optional] Credentials used for BOB authentication" - required: true - schema: - allOf: - - $ref: "#/components/schemas/Credentials" - nullable: true + - name: hostname + in: path + description: Address to connect to + required: true + schema: + $ref: '#/components/schemas/Hostname' + - name: credentials + in: path + description: '[Optional] Credentials used for BOB authentication' + required: true + schema: + allOf: + - $ref: '#/components/schemas/Credentials' + nullable: true requestBody: - description: "" + description: '' content: application/json: schema: - $ref: "#/components/schemas/BobConnectionData" + $ref: '#/components/schemas/BobConnectionData' required: true responses: - "200": + '200': description: Successful authorization - "400": + '400': description: Bad Hostname - "401": + '401': description: Bad Credentials - "404": + '404': description: Can't reach specified hostname /api/v1/logout: post: tags: - - services::auth + - services::auth operationId: logout responses: - "200": + '200': description: Logged out /api/v1/nodes/count: get: tags: - - services::api + - services::api summary: Get Nodes count per Status description: Get Nodes count per Status operationId: get_nodes_count responses: - "200": + '200': description: Node count list per status content: application/json: schema: - $ref: "#/components/schemas/NodeCount" - "401": + $ref: '#/components/schemas/NodeCount' + '401': + description: Unauthorized + security: + - api_key: [] + /api/v1/nodes/list: + get: + tags: + - services::api + summary: Returns simple list of all known nodes + description: |- + Returns simple list of all known nodes + + # Errors + + This function will return an error if a call to the primary node will fail + operationId: get_nodes_list + responses: + '200': + description: Simple Node List + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/dto.Node' + '401': description: Unauthorized security: - - api_key: [] + - api_key: [] /api/v1/nodes/rps: get: tags: - - services::api + - services::api summary: Returns Total RPS on cluster description: Returns Total RPS on cluster operationId: get_rps responses: - "200": + '200': description: RPS list per operation on all nodes content: application/json: schema: - $ref: "#/components/schemas/RPS" - "401": + $ref: '#/components/schemas/RPS' + '401': description: Unauthorized security: - - api_key: [] + - api_key: [] /api/v1/nodes/space: get: tags: - - services::api + - services::api summary: Return inforamtion about space on cluster description: Return inforamtion about space on cluster operationId: get_space responses: - "200": + '200': description: Cluster Space Information content: application/json: schema: - $ref: "#/components/schemas/SpaceInfo" - "401": + $ref: '#/components/schemas/SpaceInfo' + '401': + description: Unauthorized + security: + - api_key: [] + /api/v1/nodes/{node_name}: + get: + tags: + - services::api + summary: Returns node inforamtion by their node name + description: |- + Returns node inforamtion by their node name + + # Errors + + This function will return an error if a call to the specified node will fail or node with + specified name not found + operationId: get_node_info + responses: + '200': + description: Node Inforamtion + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + '401': + description: Unauthorized + '404': + description: Node not found + security: + - api_key: [] + /api/v1/nodes/{node_name}/configuration: + get: + tags: + - services::api + summary: Get Configuration from Node + description: |- + Get Configuration from Node + + # Errors + + This function will return an error if the server was unable to get node'a client or the request to get configuration fails + operationId: raw_configuration_by_node + responses: + '200': + description: Node's configuration + content: + application/json: + schema: + $ref: '#/components/schemas/NodeConfiguration' + '401': + description: Unauthorized + '404': + description: Node Not Found + security: + - api_key: [] + /api/v1/nodes/{node_name}/metrics: + get: + tags: + - services::api + summary: Get Raw Metrics from Node + description: |- + Get Raw Metrics from Node + + # Errors + + This function will return an error if the server was unable to get node'a client or the request to get metrics fails + operationId: raw_metrics_by_node + responses: + '200': + description: Node's metrics + content: + application/json: + schema: + $ref: '#/components/schemas/TypedMetrics' + '401': description: Unauthorized + '404': + description: Node Not Found security: - - api_key: [] + - api_key: [] components: schemas: BobConnectionData: type: object description: Data needed to connect to a BOB cluster required: - - hostname + - hostname properties: credentials: allOf: - - $ref: "#/components/schemas/Credentials" + - $ref: '#/components/schemas/Credentials' nullable: true hostname: - $ref: "#/components/schemas/Hostname" + $ref: '#/components/schemas/Hostname' example: credentials: login: archeoss - password: "12345" + password: '12345' hostname: 0.0.0.0:7000 Credentials: type: object description: Optional auth credentials for a BOB cluster required: - - login - - password + - login + - password properties: login: type: string @@ -173,14 +274,45 @@ components: description: Password used during auth example: login: archeoss - password: "12345" + password: '12345' + Disk: + type: object + description: Physical disk definition + required: + - name + - path + - status + - totalSpace + - usedSpace + - iops + properties: + iops: + type: integer + format: int64 + minimum: 0 + name: + type: string + description: Disk name + path: + type: string + description: Disk path + status: + $ref: '#/components/schemas/DiskStatus' + totalSpace: + type: integer + format: int64 + minimum: 0 + usedSpace: + type: integer + format: int64 + minimum: 0 DiskCount: type: object description: Disk count by their status required: - - good - - bad - - offline + - good + - bad + - offline properties: bad: type: integer @@ -202,38 +334,43 @@ components: type: string description: Defines kind of problem on disk enum: - - freeSpaceRunningOut + - freeSpaceRunningOut DiskStatus: oneOf: - - type: object - required: - - status - properties: - status: - type: string - enum: - - good - - type: object - required: - - status + - type: object + required: + - status + properties: + status: + type: string + enum: + - good + - type: object + required: + - status + - problems + properties: + problems: + type: object + required: - problems - properties: - problems: - type: array - items: - $ref: "#/components/schemas/DiskProblem" - status: - type: string - enum: - - bad - - type: object - required: - - status - properties: - status: - type: string - enum: - - offline + properties: + problems: + type: array + items: + $ref: '#/components/schemas/DiskProblem' + status: + type: string + enum: + - bad + - type: object + required: + - status + properties: + status: + type: string + enum: + - offline description: |- Defines disk status @@ -245,16 +382,16 @@ components: type: string description: Defines disk status names enum: - - good - - bad - - offline + - good + - bad + - offline Hostname: type: string MetricsEntryModel: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -267,12 +404,12 @@ components: MetricsSnapshotModel: type: object required: - - metrics + - metrics properties: metrics: type: object additionalProperties: - $ref: "#/components/schemas/MetricsEntryModel" + $ref: '#/components/schemas/MetricsEntryModel' NodeConfiguration: type: object properties: @@ -286,9 +423,9 @@ components: type: object description: Node count by their status required: - - good - - bad - - offline + - good + - bad + - offline properties: bad: type: integer @@ -306,46 +443,87 @@ components: bad: 0 good: 0 offline: 0 + NodeInfo: + type: object + required: + - name + - hostname + - vdisks + - status + properties: + alienCount: + type: integer + format: int64 + nullable: true + minimum: 0 + corruptedCount: + type: integer + format: int64 + nullable: true + minimum: 0 + hostname: + type: string + name: + type: string + rps: + allOf: + - $ref: '#/components/schemas/RPS' + nullable: true + space: + allOf: + - $ref: '#/components/schemas/SpaceInfo' + nullable: true + status: + $ref: '#/components/schemas/NodeStatus' + vdisks: + type: array + items: + $ref: '#/components/schemas/VDisk' NodeProblem: type: string description: Defines kind of problem on Node enum: - - aliensExists - - corruptedExists - - freeSpaceRunningOut - - virtualMemLargerThanRAM - - highCPULoad + - aliensExists + - corruptedExists + - freeSpaceRunningOut + - virtualMemLargerThanRAM + - highCPULoad NodeStatus: oneOf: - - type: object - required: - - status - properties: - status: - type: string - enum: - - good - - type: object - required: - - status + - type: object + required: + - status + properties: + status: + type: string + enum: + - good + - type: object + required: + - status + - problems + properties: + problems: + type: object + required: - problems - properties: - problems: - type: array - items: - $ref: "#/components/schemas/NodeProblem" - status: - type: string - enum: - - bad - - type: object - required: - - status - properties: - status: - type: string - enum: - - offline + properties: + problems: + type: array + items: + $ref: '#/components/schemas/NodeProblem' + status: + type: string + enum: + - bad + - type: object + required: + - status + properties: + status: + type: string + enum: + - offline description: |- Defines status of node @@ -358,25 +536,25 @@ components: type: string description: Defines node status names enum: - - good - - bad - - offline + - good + - bad + - offline Operation: type: string description: Types of operations on BOB cluster enum: - - put - - get - - exist - - delete + - put + - get + - exist + - delete RPS: type: object description: Requests per second by operation required: - - put - - get - - exist - - delete + - put + - get + - exist + - delete properties: delete: type: integer @@ -402,52 +580,74 @@ components: RawMetricEntry: type: string enum: - - cluster_grinder.get_count_rate - - cluster_grinder.put_count_rate - - cluster_grinder.exist_count_rate - - cluster_grinder.delete_count_rate - - pearl.exist_count_rate - - pearl.get_count_rate - - pearl.put_count_rate - - pearl.delete_count_rate - - backend.alien_count - - backend.corrupted_blob_count - - hardware.bob_virtual_ram - - hardware.total_ram - - hardware.used_ram - - hardware.bob_cpu_load - - hardware.free_space - - hardware.total_space - - hardware.descr_amount + - cluster_grinder.get_count_rate + - cluster_grinder.put_count_rate + - cluster_grinder.exist_count_rate + - cluster_grinder.delete_count_rate + - pearl.exist_count_rate + - pearl.get_count_rate + - pearl.put_count_rate + - pearl.delete_count_rate + - backend.alien_count + - backend.corrupted_blob_count + - hardware.bob_virtual_ram + - hardware.total_ram + - hardware.used_ram + - hardware.bob_cpu_load + - hardware.free_space + - hardware.total_space + - hardware.descr_amount + Replica: + type: object + description: '[`VDisk`]''s replicas' + required: + - node + - disk + - path + - status + properties: + disk: + type: string + node: + type: string + path: + type: string + status: + $ref: '#/components/schemas/ReplicaStatus' ReplicaProblem: type: string description: Reasons why Replica is offline enum: - - nodeUnavailable - - diskUnavailable + - nodeUnavailable + - diskUnavailable ReplicaStatus: oneOf: - - type: object - required: - - status - properties: - status: - type: string - enum: - - good - - type: object - required: - - status + - type: object + required: + - status + properties: + status: + type: string + enum: + - good + - type: object + required: + - status + - problems + properties: + problems: + type: object + required: - problems - properties: - problems: - type: array - items: - $ref: "#/components/schemas/ReplicaProblem" - status: - type: string - enum: - - offline + properties: + problems: + type: array + items: + $ref: '#/components/schemas/ReplicaProblem' + status: + type: string + enum: + - offline description: |- Replica status. It's either good or offline with the reasons why it is offline @@ -460,10 +660,10 @@ components: type: object description: Disk space information in bytes required: - - total_disk - - free_disk - - used_disk - - occupied_disk + - total_disk + - free_disk + - used_disk + - occupied_disk properties: free_disk: type: integer @@ -489,29 +689,29 @@ components: type: object description: Raw metrics information required: - - cluster_grinder.get_count_rate - - cluster_grinder.put_count_rate - - cluster_grinder.exist_count_rate - - cluster_grinder.delete_count_rate - - pearl.exist_count_rate - - pearl.get_count_rate - - pearl.put_count_rate - - pearl.delete_count_rate - - backend.alien_count - - backend.corrupted_blob_count - - hardware.bob_virtual_ram - - hardware.total_ram - - hardware.used_ram - - hardware.bob_cpu_load - - hardware.free_space - - hardware.total_space - - hardware.descr_amount + - cluster_grinder.get_count_rate + - cluster_grinder.put_count_rate + - cluster_grinder.exist_count_rate + - cluster_grinder.delete_count_rate + - pearl.exist_count_rate + - pearl.get_count_rate + - pearl.put_count_rate + - pearl.delete_count_rate + - backend.alien_count + - backend.corrupted_blob_count + - hardware.bob_virtual_ram + - hardware.total_ram + - hardware.used_ram + - hardware.bob_cpu_load + - hardware.free_space + - hardware.total_space + - hardware.descr_amount properties: backend.alien_count: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -524,8 +724,8 @@ components: backend.corrupted_blob_count: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -538,8 +738,8 @@ components: cluster_grinder.delete_count_rate: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -552,8 +752,8 @@ components: cluster_grinder.exist_count_rate: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -566,8 +766,8 @@ components: cluster_grinder.get_count_rate: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -580,8 +780,8 @@ components: cluster_grinder.put_count_rate: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -594,8 +794,8 @@ components: hardware.bob_cpu_load: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -608,8 +808,8 @@ components: hardware.bob_virtual_ram: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -622,8 +822,8 @@ components: hardware.descr_amount: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -636,8 +836,8 @@ components: hardware.free_space: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -650,8 +850,8 @@ components: hardware.total_ram: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -664,8 +864,8 @@ components: hardware.total_space: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -678,8 +878,8 @@ components: hardware.used_ram: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -692,8 +892,8 @@ components: pearl.delete_count_rate: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -706,8 +906,8 @@ components: pearl.exist_count_rate: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -720,8 +920,8 @@ components: pearl.get_count_rate: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -734,8 +934,8 @@ components: pearl.put_count_rate: type: object required: - - value - - timestamp + - value + - timestamp properties: timestamp: type: integer @@ -797,44 +997,111 @@ components: pearl.put_count_rate: timestamp: 0 value: 0 + VDisk: + type: object + description: Virtual disk Component + required: + - id + - status + - partitionCount + - replicas + properties: + id: + type: integer + format: int64 + minimum: 0 + partitionCount: + type: integer + format: int64 + minimum: 0 + replicas: + type: array + items: + $ref: '#/components/schemas/Replica' + status: + $ref: '#/components/schemas/VDiskStatus' VDiskStatus: oneOf: - - type: object - required: - - status - properties: - status: - type: string - enum: - - good - - type: object - required: - - status - properties: - status: - type: string - enum: - - bad - - type: object - required: - - status - properties: - status: - type: string - enum: - - offline + - type: object + required: + - status + properties: + status: + type: string + enum: + - good + - type: object + required: + - status + properties: + status: + type: string + enum: + - bad + - type: object + required: + - status + properties: + status: + type: string + enum: + - offline description: |- Virtual disk status. Variants - Virtual Disk status status == 'bad' when at least one of its replicas has problems - example: - status: good + dto.Node: + type: object + required: + - name + - address + properties: + address: + type: string + name: + type: string + vdisks: + type: array + items: + $ref: '#/components/schemas/dto.VDisk' + nullable: true + dto.Replica: + type: object + required: + - node + - disk + - path + properties: + disk: + type: string + node: + type: string + path: + type: string + dto.VDisk: + type: object + required: + - id + properties: + id: + type: integer + format: int32 + replicas: + type: array + items: + $ref: '#/components/schemas/dto.Replica' + nullable: true securitySchemes: api_key: type: apiKey in: header name: bob_apikey tags: +<<<<<<< HEAD - name: bob description: BOB management API +======= +- name: bob + description: BOB management API +>>>>>>> 7d85adf (Autogenerate API)