-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: mohamed-ben-khemis <[email protected]>
- Loading branch information
1 parent
4cbc26e
commit 153dd94
Showing
9 changed files
with
324 additions
and
2 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
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
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,110 @@ | ||
| // Package docs Code generated by swaggo/swag. DO NOT EDIT | ||
| package docs | ||
|
|
||
| import "github.com/swaggo/swag" | ||
|
|
||
| const docTemplate = `{ | ||
| "schemes": {{ marshal .Schemes }}, | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "description": "{{escape .Description}}", | ||
| "title": "{{.Title}}", | ||
| "contact": {}, | ||
| "license": { | ||
| "name": "License: Apache 2.0", | ||
| "url": "http://www.apache.org/licenses/LICENSE-2.0.html" | ||
| }, | ||
| "version": "{{.Version}}" | ||
| }, | ||
| "host": "{{.Host}}", | ||
| "basePath": "{{.BasePath}}", | ||
| "paths": { | ||
| "/healthcheck": { | ||
| "get": { | ||
| "description": "Provides a healthcheck response indicating the status of key services.", | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "tags": [ | ||
| "healthcheck" | ||
| ], | ||
| "summary": "Returns the health status of the application", | ||
| "responses": { | ||
| "200": { | ||
| "description": "Successful healthcheck response", | ||
| "schema": { | ||
| "$ref": "#/definitions/health_check.HealthCheck" | ||
| } | ||
| }, | ||
| "500": { | ||
| "description": "Internal server error", | ||
| "schema": { | ||
| "$ref": "#/definitions/api.ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "api.ErrorResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "code": { | ||
| "type": "string" | ||
| }, | ||
| "message": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "health_check.HealthCheck": { | ||
| "type": "object", | ||
| "properties": { | ||
| "status": { | ||
| "$ref": "#/definitions/health_check.ServiceStatus" | ||
| }, | ||
| "system_info": { | ||
| "$ref": "#/definitions/health_check.SystemInfo" | ||
| } | ||
| } | ||
| }, | ||
| "health_check.ServiceStatus": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "Healthy", | ||
| "Unhealthy" | ||
| ], | ||
| "x-enum-varnames": [ | ||
| "ServiceStatusHealthy", | ||
| "ServiceStatusUnhealthy" | ||
| ] | ||
| }, | ||
| "health_check.SystemInfo": { | ||
| "type": "object", | ||
| "properties": { | ||
| "version": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }` | ||
|
|
||
| // SwaggerInfo holds exported Swagger Info so clients can modify it | ||
| var SwaggerInfo = &swag.Spec{ | ||
| Version: "1.0.0", | ||
| Host: "localhost:4000", | ||
| BasePath: "/api/v1", | ||
| Schemes: []string{}, | ||
| Title: "Kubeflow Notebooks API", | ||
| Description: "This API provides endpoints to manage notebooks in a Kubernetes cluster.\nFor more information, visit https://www.kubeflow.org/docs/components/notebooks/", | ||
| InfoInstanceName: "swagger", | ||
| SwaggerTemplate: docTemplate, | ||
| LeftDelim: "{{", | ||
| RightDelim: "}}", | ||
| } | ||
|
|
||
| func init() { | ||
| swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) | ||
| } |
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,86 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "description": "This API provides endpoints to manage notebooks in a Kubernetes cluster.\nFor more information, visit https://www.kubeflow.org/docs/components/notebooks/", | ||
| "title": "Kubeflow Notebooks API", | ||
| "contact": {}, | ||
| "license": { | ||
| "name": "License: Apache 2.0", | ||
| "url": "http://www.apache.org/licenses/LICENSE-2.0.html" | ||
| }, | ||
| "version": "1.0.0" | ||
| }, | ||
| "host": "localhost:4000", | ||
| "basePath": "/api/v1", | ||
| "paths": { | ||
| "/healthcheck": { | ||
| "get": { | ||
| "description": "Provides a healthcheck response indicating the status of key services.", | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "tags": [ | ||
| "healthcheck" | ||
| ], | ||
| "summary": "Returns the health status of the application", | ||
| "responses": { | ||
| "200": { | ||
| "description": "Successful healthcheck response", | ||
| "schema": { | ||
| "$ref": "#/definitions/health_check.HealthCheck" | ||
| } | ||
| }, | ||
| "500": { | ||
| "description": "Internal server error", | ||
| "schema": { | ||
| "$ref": "#/definitions/api.ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "api.ErrorResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "code": { | ||
| "type": "string" | ||
| }, | ||
| "message": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "health_check.HealthCheck": { | ||
| "type": "object", | ||
| "properties": { | ||
| "status": { | ||
| "$ref": "#/definitions/health_check.ServiceStatus" | ||
| }, | ||
| "system_info": { | ||
| "$ref": "#/definitions/health_check.SystemInfo" | ||
| } | ||
| } | ||
| }, | ||
| "health_check.ServiceStatus": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "Healthy", | ||
| "Unhealthy" | ||
| ], | ||
| "x-enum-varnames": [ | ||
| "ServiceStatusHealthy", | ||
| "ServiceStatusUnhealthy" | ||
| ] | ||
| }, | ||
| "health_check.SystemInfo": { | ||
| "type": "object", | ||
| "properties": { | ||
| "version": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
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,59 @@ | ||
| basePath: /api/v1 | ||
| definitions: | ||
| api.ErrorResponse: | ||
| properties: | ||
| code: | ||
| type: string | ||
| message: | ||
| type: string | ||
| type: object | ||
| health_check.HealthCheck: | ||
| properties: | ||
| status: | ||
| $ref: '#/definitions/health_check.ServiceStatus' | ||
| system_info: | ||
| $ref: '#/definitions/health_check.SystemInfo' | ||
| type: object | ||
| health_check.ServiceStatus: | ||
| enum: | ||
| - Healthy | ||
| - Unhealthy | ||
| type: string | ||
| x-enum-varnames: | ||
| - ServiceStatusHealthy | ||
| - ServiceStatusUnhealthy | ||
| health_check.SystemInfo: | ||
| properties: | ||
| version: | ||
| type: string | ||
| type: object | ||
| host: localhost:4000 | ||
| info: | ||
| contact: {} | ||
| description: |- | ||
| This API provides endpoints to manage notebooks in a Kubernetes cluster. | ||
| For more information, visit https://www.kubeflow.org/docs/components/notebooks/ | ||
| license: | ||
| name: 'License: Apache 2.0' | ||
| url: http://www.apache.org/licenses/LICENSE-2.0.html | ||
| title: Kubeflow Notebooks API | ||
| version: 1.0.0 | ||
| paths: | ||
| /healthcheck: | ||
| get: | ||
| description: Provides a healthcheck response indicating the status of key services. | ||
| produces: | ||
| - application/json | ||
| responses: | ||
| "200": | ||
| description: Successful healthcheck response | ||
| schema: | ||
| $ref: '#/definitions/health_check.HealthCheck' | ||
| "500": | ||
| description: Internal server error | ||
| schema: | ||
| $ref: '#/definitions/api.ErrorResponse' | ||
| summary: Returns the health status of the application | ||
| tags: | ||
| - healthcheck | ||
| swagger: "2.0" |
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
Oops, something went wrong.