diff options
| author | Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> | 2023-04-20 14:42:19 +0000 |
|---|---|---|
| committer | Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> | 2023-04-21 23:57:31 +0300 |
| commit | 91a7475abde54a342510fc481f3294a4d1f507d0 (patch) | |
| tree | cc95b6c22fcc454b119bae2f0d5ee5112579a967 /docs | |
| parent | possible db schema for community (diff) | |
| download | lphub-91a7475abde54a342510fc481f3294a4d1f507d0.tar.gz lphub-91a7475abde54a342510fc481f3294a4d1f507d0.tar.bz2 lphub-91a7475abde54a342510fc481f3294a4d1f507d0.zip | |
finalize swagger, port to prod machine (#34)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs.go | 40 | ||||
| -rw-r--r-- | docs/swagger.json | 34 | ||||
| -rw-r--r-- | docs/swagger.yaml | 25 |
3 files changed, 93 insertions, 6 deletions
diff --git a/docs/docs.go b/docs/docs.go index 40bae17..70a7267 100644 --- a/docs/docs.go +++ b/docs/docs.go | |||
| @@ -1,5 +1,5 @@ | |||
| 1 | // Package docs GENERATED BY SWAG; DO NOT EDIT | 1 | // Code generated by swaggo/swag. DO NOT EDIT. |
| 2 | // This file was generated by swaggo/swag | 2 | |
| 3 | package docs | 3 | package docs |
| 4 | 4 | ||
| 5 | import "github.com/swaggo/swag" | 5 | import "github.com/swaggo/swag" |
| @@ -152,6 +152,7 @@ const docTemplate = `{ | |||
| 152 | "items": { | 152 | "items": { |
| 153 | "type": "file" | 153 | "type": "file" |
| 154 | }, | 154 | }, |
| 155 | "collectionFormat": "csv", | ||
| 155 | "description": "Demos", | 156 | "description": "Demos", |
| 156 | "name": "demos", | 157 | "name": "demos", |
| 157 | "in": "formData", | 158 | "in": "formData", |
| @@ -469,6 +470,23 @@ const docTemplate = `{ | |||
| 469 | } | 470 | } |
| 470 | } | 471 | } |
| 471 | }, | 472 | }, |
| 473 | "models.RankingsResponse": { | ||
| 474 | "type": "object", | ||
| 475 | "properties": { | ||
| 476 | "rankings_mp": { | ||
| 477 | "type": "array", | ||
| 478 | "items": { | ||
| 479 | "$ref": "#/definitions/models.UserRanking" | ||
| 480 | } | ||
| 481 | }, | ||
| 482 | "rankings_sp": { | ||
| 483 | "type": "array", | ||
| 484 | "items": { | ||
| 485 | "$ref": "#/definitions/models.UserRanking" | ||
| 486 | } | ||
| 487 | } | ||
| 488 | } | ||
| 489 | }, | ||
| 472 | "models.RecordRequest": { | 490 | "models.RecordRequest": { |
| 473 | "type": "object", | 491 | "type": "object", |
| 474 | "required": [ | 492 | "required": [ |
| @@ -512,6 +530,20 @@ const docTemplate = `{ | |||
| 512 | }, | 530 | }, |
| 513 | "records": {} | 531 | "records": {} |
| 514 | } | 532 | } |
| 533 | }, | ||
| 534 | "models.UserRanking": { | ||
| 535 | "type": "object", | ||
| 536 | "properties": { | ||
| 537 | "total_score": { | ||
| 538 | "type": "integer" | ||
| 539 | }, | ||
| 540 | "user_id": { | ||
| 541 | "type": "string" | ||
| 542 | }, | ||
| 543 | "username": { | ||
| 544 | "type": "string" | ||
| 545 | } | ||
| 546 | } | ||
| 515 | } | 547 | } |
| 516 | } | 548 | } |
| 517 | }` | 549 | }` |
| @@ -519,13 +551,15 @@ const docTemplate = `{ | |||
| 519 | // SwaggerInfo holds exported Swagger Info so clients can modify it | 551 | // SwaggerInfo holds exported Swagger Info so clients can modify it |
| 520 | var SwaggerInfo = &swag.Spec{ | 552 | var SwaggerInfo = &swag.Spec{ |
| 521 | Version: "1.0", | 553 | Version: "1.0", |
| 522 | Host: "localhost:4000/api", | 554 | Host: "lp.ardapektezol.com/api", |
| 523 | BasePath: "/v1", | 555 | BasePath: "/v1", |
| 524 | Schemes: []string{}, | 556 | Schemes: []string{}, |
| 525 | Title: "Least Portals Database API", | 557 | Title: "Least Portals Database API", |
| 526 | Description: "Backend API endpoints for Least Portals Database.", | 558 | Description: "Backend API endpoints for Least Portals Database.", |
| 527 | InfoInstanceName: "swagger", | 559 | InfoInstanceName: "swagger", |
| 528 | SwaggerTemplate: docTemplate, | 560 | SwaggerTemplate: docTemplate, |
| 561 | LeftDelim: "{{", | ||
| 562 | RightDelim: "}}", | ||
| 529 | } | 563 | } |
| 530 | 564 | ||
| 531 | func init() { | 565 | func init() { |
diff --git a/docs/swagger.json b/docs/swagger.json index 03a2592..861610b 100644 --- a/docs/swagger.json +++ b/docs/swagger.json | |||
| @@ -10,7 +10,7 @@ | |||
| 10 | }, | 10 | }, |
| 11 | "version": "1.0" | 11 | "version": "1.0" |
| 12 | }, | 12 | }, |
| 13 | "host": "localhost:4000/api", | 13 | "host": "lp.ardapektezol.com/api", |
| 14 | "basePath": "/v1", | 14 | "basePath": "/v1", |
| 15 | "paths": { | 15 | "paths": { |
| 16 | "/demo": { | 16 | "/demo": { |
| @@ -145,6 +145,7 @@ | |||
| 145 | "items": { | 145 | "items": { |
| 146 | "type": "file" | 146 | "type": "file" |
| 147 | }, | 147 | }, |
| 148 | "collectionFormat": "csv", | ||
| 148 | "description": "Demos", | 149 | "description": "Demos", |
| 149 | "name": "demos", | 150 | "name": "demos", |
| 150 | "in": "formData", | 151 | "in": "formData", |
| @@ -462,6 +463,23 @@ | |||
| 462 | } | 463 | } |
| 463 | } | 464 | } |
| 464 | }, | 465 | }, |
| 466 | "models.RankingsResponse": { | ||
| 467 | "type": "object", | ||
| 468 | "properties": { | ||
| 469 | "rankings_mp": { | ||
| 470 | "type": "array", | ||
| 471 | "items": { | ||
| 472 | "$ref": "#/definitions/models.UserRanking" | ||
| 473 | } | ||
| 474 | }, | ||
| 475 | "rankings_sp": { | ||
| 476 | "type": "array", | ||
| 477 | "items": { | ||
| 478 | "$ref": "#/definitions/models.UserRanking" | ||
| 479 | } | ||
| 480 | } | ||
| 481 | } | ||
| 482 | }, | ||
| 465 | "models.RecordRequest": { | 483 | "models.RecordRequest": { |
| 466 | "type": "object", | 484 | "type": "object", |
| 467 | "required": [ | 485 | "required": [ |
| @@ -505,6 +523,20 @@ | |||
| 505 | }, | 523 | }, |
| 506 | "records": {} | 524 | "records": {} |
| 507 | } | 525 | } |
| 526 | }, | ||
| 527 | "models.UserRanking": { | ||
| 528 | "type": "object", | ||
| 529 | "properties": { | ||
| 530 | "total_score": { | ||
| 531 | "type": "integer" | ||
| 532 | }, | ||
| 533 | "user_id": { | ||
| 534 | "type": "string" | ||
| 535 | }, | ||
| 536 | "username": { | ||
| 537 | "type": "string" | ||
| 538 | } | ||
| 539 | } | ||
| 508 | } | 540 | } |
| 509 | } | 541 | } |
| 510 | } \ No newline at end of file | 542 | } \ No newline at end of file |
diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 5300e1f..db0ab47 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml | |||
| @@ -40,6 +40,17 @@ definitions: | |||
| 40 | username: | 40 | username: |
| 41 | type: string | 41 | type: string |
| 42 | type: object | 42 | type: object |
| 43 | models.RankingsResponse: | ||
| 44 | properties: | ||
| 45 | rankings_mp: | ||
| 46 | items: | ||
| 47 | $ref: '#/definitions/models.UserRanking' | ||
| 48 | type: array | ||
| 49 | rankings_sp: | ||
| 50 | items: | ||
| 51 | $ref: '#/definitions/models.UserRanking' | ||
| 52 | type: array | ||
| 53 | type: object | ||
| 43 | models.RecordRequest: | 54 | models.RecordRequest: |
| 44 | properties: | 55 | properties: |
| 45 | is_partner_orange: | 56 | is_partner_orange: |
| @@ -70,7 +81,16 @@ definitions: | |||
| 70 | type: integer | 81 | type: integer |
| 71 | records: {} | 82 | records: {} |
| 72 | type: object | 83 | type: object |
| 73 | host: localhost:4000/api | 84 | models.UserRanking: |
| 85 | properties: | ||
| 86 | total_score: | ||
| 87 | type: integer | ||
| 88 | user_id: | ||
| 89 | type: string | ||
| 90 | username: | ||
| 91 | type: string | ||
| 92 | type: object | ||
| 93 | host: lp.ardapektezol.com/api | ||
| 74 | info: | 94 | info: |
| 75 | contact: {} | 95 | contact: {} |
| 76 | description: Backend API endpoints for Least Portals Database. | 96 | description: Backend API endpoints for Least Portals Database. |
| @@ -155,7 +175,8 @@ paths: | |||
| 155 | consumes: | 175 | consumes: |
| 156 | - multipart/form-data | 176 | - multipart/form-data |
| 157 | parameters: | 177 | parameters: |
| 158 | - description: Demos | 178 | - collectionFormat: csv |
| 179 | description: Demos | ||
| 159 | in: formData | 180 | in: formData |
| 160 | items: | 181 | items: |
| 161 | type: file | 182 | type: file |