|
1 | 1 | { |
2 | 2 | "openapi": "3.0.3", |
3 | 3 | "info": { |
4 | | - "title": "Geo Engine Pro API", |
| 4 | + "title": "Geo Engine API", |
5 | 5 | "description": "", |
6 | 6 | "contact": { |
7 | 7 | "name": "Geo Engine Developers", |
|
15 | 15 | }, |
16 | 16 | "servers": [ |
17 | 17 | { |
18 | | - "url": "http://localhost:3030/api" |
| 18 | + "url": "http://127.0.0.1:3030/api" |
19 | 19 | } |
20 | 20 | ], |
21 | 21 | "paths": { |
|
3106 | 3106 | ] |
3107 | 3107 | } |
3108 | 3108 | }, |
| 3109 | + "/quota/computations": { |
| 3110 | + "get": { |
| 3111 | + "tags": [ |
| 3112 | + "User" |
| 3113 | + ], |
| 3114 | + "summary": "Retrieves the quota used by computations", |
| 3115 | + "operationId": "computations_quota_handler", |
| 3116 | + "parameters": [ |
| 3117 | + { |
| 3118 | + "name": "offset", |
| 3119 | + "in": "query", |
| 3120 | + "required": true, |
| 3121 | + "schema": { |
| 3122 | + "type": "integer", |
| 3123 | + "minimum": 0 |
| 3124 | + } |
| 3125 | + }, |
| 3126 | + { |
| 3127 | + "name": "limit", |
| 3128 | + "in": "query", |
| 3129 | + "required": true, |
| 3130 | + "schema": { |
| 3131 | + "type": "integer", |
| 3132 | + "minimum": 0 |
| 3133 | + } |
| 3134 | + } |
| 3135 | + ], |
| 3136 | + "responses": { |
| 3137 | + "200": { |
| 3138 | + "description": "The quota used by computations", |
| 3139 | + "content": { |
| 3140 | + "application/json": { |
| 3141 | + "schema": { |
| 3142 | + "type": "array", |
| 3143 | + "items": { |
| 3144 | + "$ref": "#/components/schemas/ComputationQuota" |
| 3145 | + } |
| 3146 | + } |
| 3147 | + } |
| 3148 | + } |
| 3149 | + } |
| 3150 | + }, |
| 3151 | + "security": [ |
| 3152 | + { |
| 3153 | + "session_token": [] |
| 3154 | + } |
| 3155 | + ] |
| 3156 | + } |
| 3157 | + }, |
| 3158 | + "/quota/computations/{computation}": { |
| 3159 | + "get": { |
| 3160 | + "tags": [ |
| 3161 | + "User" |
| 3162 | + ], |
| 3163 | + "summary": "Retrieves the quota used by computations", |
| 3164 | + "operationId": "computation_quota_handler", |
| 3165 | + "parameters": [ |
| 3166 | + { |
| 3167 | + "name": "computation", |
| 3168 | + "in": "path", |
| 3169 | + "description": "Computation id", |
| 3170 | + "required": true, |
| 3171 | + "schema": { |
| 3172 | + "type": "string", |
| 3173 | + "format": "uuid" |
| 3174 | + } |
| 3175 | + } |
| 3176 | + ], |
| 3177 | + "responses": { |
| 3178 | + "200": { |
| 3179 | + "description": "The quota used by computation", |
| 3180 | + "content": { |
| 3181 | + "application/json": { |
| 3182 | + "schema": { |
| 3183 | + "type": "array", |
| 3184 | + "items": { |
| 3185 | + "$ref": "#/components/schemas/OperatorQuota" |
| 3186 | + } |
| 3187 | + } |
| 3188 | + } |
| 3189 | + } |
| 3190 | + } |
| 3191 | + }, |
| 3192 | + "security": [ |
| 3193 | + { |
| 3194 | + "session_token": [] |
| 3195 | + } |
| 3196 | + ] |
| 3197 | + } |
| 3198 | + }, |
| 3199 | + "/quota/dataUsage": { |
| 3200 | + "get": { |
| 3201 | + "tags": [ |
| 3202 | + "User" |
| 3203 | + ], |
| 3204 | + "summary": "Retrieves the quota used on data", |
| 3205 | + "operationId": "data_usage_handler", |
| 3206 | + "parameters": [ |
| 3207 | + { |
| 3208 | + "name": "offset", |
| 3209 | + "in": "query", |
| 3210 | + "required": true, |
| 3211 | + "schema": { |
| 3212 | + "type": "integer", |
| 3213 | + "format": "int64", |
| 3214 | + "minimum": 0 |
| 3215 | + } |
| 3216 | + }, |
| 3217 | + { |
| 3218 | + "name": "limit", |
| 3219 | + "in": "query", |
| 3220 | + "required": true, |
| 3221 | + "schema": { |
| 3222 | + "type": "integer", |
| 3223 | + "format": "int64", |
| 3224 | + "minimum": 0 |
| 3225 | + } |
| 3226 | + } |
| 3227 | + ], |
| 3228 | + "responses": { |
| 3229 | + "200": { |
| 3230 | + "description": "The quota used on data", |
| 3231 | + "content": { |
| 3232 | + "application/json": { |
| 3233 | + "schema": { |
| 3234 | + "type": "array", |
| 3235 | + "items": { |
| 3236 | + "$ref": "#/components/schemas/DataUsage" |
| 3237 | + } |
| 3238 | + } |
| 3239 | + } |
| 3240 | + } |
| 3241 | + } |
| 3242 | + }, |
| 3243 | + "security": [ |
| 3244 | + { |
| 3245 | + "session_token": [] |
| 3246 | + } |
| 3247 | + ] |
| 3248 | + } |
| 3249 | + }, |
| 3250 | + "/quota/dataUsage/summary": { |
| 3251 | + "get": { |
| 3252 | + "tags": [ |
| 3253 | + "User" |
| 3254 | + ], |
| 3255 | + "summary": "Retrieves the quota used by computations", |
| 3256 | + "operationId": "data_usage_summary_handler", |
| 3257 | + "parameters": [ |
| 3258 | + { |
| 3259 | + "name": "granularity", |
| 3260 | + "in": "query", |
| 3261 | + "required": true, |
| 3262 | + "schema": { |
| 3263 | + "$ref": "#/components/schemas/UsageSummaryGranularity" |
| 3264 | + } |
| 3265 | + }, |
| 3266 | + { |
| 3267 | + "name": "offset", |
| 3268 | + "in": "query", |
| 3269 | + "required": true, |
| 3270 | + "schema": { |
| 3271 | + "type": "integer", |
| 3272 | + "format": "int64", |
| 3273 | + "minimum": 0 |
| 3274 | + } |
| 3275 | + }, |
| 3276 | + { |
| 3277 | + "name": "limit", |
| 3278 | + "in": "query", |
| 3279 | + "required": true, |
| 3280 | + "schema": { |
| 3281 | + "type": "integer", |
| 3282 | + "format": "int64", |
| 3283 | + "minimum": 0 |
| 3284 | + } |
| 3285 | + }, |
| 3286 | + { |
| 3287 | + "name": "dataset", |
| 3288 | + "in": "query", |
| 3289 | + "required": false, |
| 3290 | + "schema": { |
| 3291 | + "type": "string", |
| 3292 | + "nullable": true |
| 3293 | + } |
| 3294 | + } |
| 3295 | + ], |
| 3296 | + "responses": { |
| 3297 | + "200": { |
| 3298 | + "description": "The quota used on data", |
| 3299 | + "content": { |
| 3300 | + "application/json": { |
| 3301 | + "schema": { |
| 3302 | + "type": "array", |
| 3303 | + "items": { |
| 3304 | + "$ref": "#/components/schemas/DataUsageSummary" |
| 3305 | + } |
| 3306 | + } |
| 3307 | + } |
| 3308 | + } |
| 3309 | + } |
| 3310 | + }, |
| 3311 | + "security": [ |
| 3312 | + { |
| 3313 | + "session_token": [] |
| 3314 | + } |
| 3315 | + ] |
| 3316 | + } |
| 3317 | + }, |
3109 | 3318 | "/quotas/{user}": { |
3110 | 3319 | "get": { |
3111 | 3320 | "tags": [ |
|
5477 | 5686 | } |
5478 | 5687 | } |
5479 | 5688 | }, |
| 5689 | + "ComputationQuota": { |
| 5690 | + "type": "object", |
| 5691 | + "required": [ |
| 5692 | + "timestamp", |
| 5693 | + "computationId", |
| 5694 | + "workflowId", |
| 5695 | + "count" |
| 5696 | + ], |
| 5697 | + "properties": { |
| 5698 | + "computationId": { |
| 5699 | + "type": "string", |
| 5700 | + "format": "uuid" |
| 5701 | + }, |
| 5702 | + "count": { |
| 5703 | + "type": "integer", |
| 5704 | + "format": "int64", |
| 5705 | + "minimum": 0 |
| 5706 | + }, |
| 5707 | + "timestamp": { |
| 5708 | + "type": "string", |
| 5709 | + "format": "date-time" |
| 5710 | + }, |
| 5711 | + "workflowId": { |
| 5712 | + "type": "string", |
| 5713 | + "format": "uuid" |
| 5714 | + } |
| 5715 | + } |
| 5716 | + }, |
5480 | 5717 | "ContinuousMeasurement": { |
5481 | 5718 | "type": "object", |
5482 | 5719 | "required": [ |
|
5638 | 5875 | "type": "string", |
5639 | 5876 | "format": "uuid" |
5640 | 5877 | }, |
| 5878 | + "DataUsage": { |
| 5879 | + "type": "object", |
| 5880 | + "required": [ |
| 5881 | + "timestamp", |
| 5882 | + "userId", |
| 5883 | + "computationId", |
| 5884 | + "data", |
| 5885 | + "count" |
| 5886 | + ], |
| 5887 | + "properties": { |
| 5888 | + "computationId": { |
| 5889 | + "type": "string", |
| 5890 | + "format": "uuid" |
| 5891 | + }, |
| 5892 | + "count": { |
| 5893 | + "type": "integer", |
| 5894 | + "format": "int64", |
| 5895 | + "minimum": 0 |
| 5896 | + }, |
| 5897 | + "data": { |
| 5898 | + "type": "string" |
| 5899 | + }, |
| 5900 | + "timestamp": { |
| 5901 | + "type": "string", |
| 5902 | + "format": "date-time" |
| 5903 | + }, |
| 5904 | + "userId": { |
| 5905 | + "type": "string", |
| 5906 | + "format": "uuid" |
| 5907 | + } |
| 5908 | + } |
| 5909 | + }, |
| 5910 | + "DataUsageSummary": { |
| 5911 | + "type": "object", |
| 5912 | + "required": [ |
| 5913 | + "timestamp", |
| 5914 | + "data", |
| 5915 | + "count" |
| 5916 | + ], |
| 5917 | + "properties": { |
| 5918 | + "count": { |
| 5919 | + "type": "integer", |
| 5920 | + "format": "int64", |
| 5921 | + "minimum": 0 |
| 5922 | + }, |
| 5923 | + "data": { |
| 5924 | + "type": "string" |
| 5925 | + }, |
| 5926 | + "timestamp": { |
| 5927 | + "type": "string", |
| 5928 | + "format": "date-time" |
| 5929 | + } |
| 5930 | + } |
| 5931 | + }, |
5641 | 5932 | "Dataset": { |
5642 | 5933 | "type": "object", |
5643 | 5934 | "required": [ |
|
7378 | 7669 | } |
7379 | 7670 | } |
7380 | 7671 | }, |
| 7672 | + "OperatorQuota": { |
| 7673 | + "type": "object", |
| 7674 | + "required": [ |
| 7675 | + "operatorName", |
| 7676 | + "operatorPath", |
| 7677 | + "count" |
| 7678 | + ], |
| 7679 | + "properties": { |
| 7680 | + "count": { |
| 7681 | + "type": "integer", |
| 7682 | + "format": "int64", |
| 7683 | + "minimum": 0 |
| 7684 | + }, |
| 7685 | + "operatorName": { |
| 7686 | + "type": "string" |
| 7687 | + }, |
| 7688 | + "operatorPath": { |
| 7689 | + "type": "string" |
| 7690 | + } |
| 7691 | + } |
| 7692 | + }, |
7381 | 7693 | "OrderBy": { |
7382 | 7694 | "type": "string", |
7383 | 7695 | "enum": [ |
|
9427 | 9739 | "type": "string", |
9428 | 9740 | "format": "uuid" |
9429 | 9741 | }, |
| 9742 | + "UsageSummaryGranularity": { |
| 9743 | + "type": "string", |
| 9744 | + "enum": [ |
| 9745 | + "minutes", |
| 9746 | + "hours", |
| 9747 | + "days", |
| 9748 | + "months", |
| 9749 | + "years" |
| 9750 | + ] |
| 9751 | + }, |
9430 | 9752 | "UserCredentials": { |
9431 | 9753 | "type": "object", |
9432 | 9754 | "required": [ |
|
0 commit comments