[CS-04] Adds Open Api #13
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: Swagger certificate service - OpenAPI 3.0 | ||
| version: 0.0.1 | ||
| description: "Open API for the certificate microservice" | ||
| servers: | ||
| - url: http://localhost:8080/certificateService | ||
| paths: | ||
| /generatecertificate: | ||
| post: | ||
| tags: | ||
| - certificate | ||
| summary: Method for certificate generating | ||
| description: '' | ||
| operationId: generateCertificate | ||
| parameters: | ||
| - name: student | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: course | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: courseType | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: templateName | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: hours | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: number | ||
| format: float | ||
| requestBody: | ||
| content: | ||
| application/octet-stream: | ||
| schema: | ||
| type: string | ||
| format: binary | ||
| responses: | ||
| '200': | ||
| description: successful operation | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/Certificate' | ||
| '400': | ||
| description: Invalid parameters | ||
| '404': | ||
| description: Not found | ||
| '500': | ||
| description: Internal server error | ||
| default: | ||
| description: Unexpected error | ||
|
|
||
|
|
||
| components: | ||
| schemas: | ||
| Certificate: | ||
| type: object | ||
| required: | ||
| - name | ||
| - status | ||
| properties: | ||
| name: | ||
| 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,62 @@ | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: Swagger certificate service - OpenAPI 3.0 | ||
| version: 0.0.1 | ||
| description: "Open API for the certificate microservice" | ||
| servers: | ||
| - url: http://localhost:8080/certificateService | ||
| paths: | ||
| /generatename: | ||
| post: | ||
| tags: | ||
| - file | ||
| summary: Method for generating the file name | ||
| description: '' | ||
| operationId: generateName | ||
| parameters: | ||
| - name: student | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: course | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: templateName | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| requestBody: | ||
| content: | ||
| application/octet-stream: | ||
| schema: | ||
| type: string | ||
| format: binary | ||
| responses: | ||
| '200': | ||
| description: successful operation | ||
| content: | ||
| application/json: | ||
| schema: | ||
| properties: | ||
| id: | ||
| type: string | ||
| format: binary | ||
| '400': | ||
| description: Invalid parameters | ||
| '404': | ||
| description: Not found | ||
| '500': | ||
| description: Internal server error | ||
| default: | ||
| description: Unexpected error | ||
|
|
||
|
|
||
|
|
||
|
|
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,65 @@ | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: Swagger certificate service - OpenAPI 3.0 | ||
| version: 0.0.1 | ||
| description: "Open API for the certificate microservice" | ||
| servers: | ||
| - url: http://localhost:8080/certificateService | ||
| paths: | ||
| /getcertificate: | ||
| post: | ||
| tags: | ||
| - Certificate | ||
| summary: Method to handle a web-service request | ||
| description: '' | ||
| operationId: webrequest | ||
| parameters: | ||
| - name: student | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: course | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: templateName | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| requestBody: | ||
| content: | ||
| application/octet-stream: | ||
| schema: | ||
| type: string | ||
| format: binary | ||
| responses: | ||
| '200': | ||
| description: successful operation | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/Certificate' | ||
| '400': | ||
| description: Invalid parameters | ||
| '404': | ||
| description: Not found | ||
| '500': | ||
| description: Internal server error | ||
| default: | ||
| description: Unexpected error | ||
|
|
||
|
|
||
| components: | ||
| schemas: | ||
| Certificate: | ||
| type: object | ||
| properties: | ||
| certificate: | ||
| type: string | ||
| format: byte |
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,45 @@ | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: Swagger certificate service - OpenAPI 3.0 | ||
| version: 0.0.1 | ||
| description: "Open API for the certificate microservice" | ||
| servers: | ||
| - url: http://localhost:8080/certificateService | ||
| paths: | ||
| /savefile: | ||
| post: | ||
| tags: | ||
| - file | ||
| summary: Method for saving a file to the storage | ||
| description: '' | ||
| operationId: saveFile | ||
| parameters: | ||
| - name: templateName | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| requestBody: | ||
| content: | ||
| application/octet-stream: | ||
| schema: | ||
| type: string | ||
| format: binary | ||
| responses: | ||
| '200': | ||
| description: successful operation | ||
| content: | ||
| application/json: | ||
| schema: | ||
| properties: | ||
| path: | ||
| type: string | ||
| '400': | ||
| description: Invalid parameters | ||
| '404': | ||
| description: Not found | ||
| '500': | ||
| description: Internal server error | ||
| default: | ||
| description: Unexpected error |
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,47 @@ | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: Swagger certificate service - OpenAPI 3.0 | ||
| version: 0.0.1 | ||
| description: "Open API for the certificate microservice" | ||
| servers: | ||
| - url: http://localhost:8080/certificateService | ||
| paths: | ||
| /selecttemplate: | ||
| post: | ||
| tags: | ||
| - template | ||
| summary: Method for selecting template from storage | ||
|
There was a problem hiding this comment. Это, похоже, внутренний запрос. Не стоит смешивать внешние/внутренние запросы |
||
| description: '' | ||
| operationId: selectTemplate | ||
| parameters: | ||
| - name: templateName | ||
| in: query | ||
| description: '' | ||
| required: true | ||
| schema: | ||
| type: string | ||
| requestBody: | ||
| content: | ||
| application/octet-stream: | ||
| schema: | ||
| type: string | ||
| format: binary | ||
| responses: | ||
| '200': | ||
| description: successful operation | ||
| content: | ||
| application/json: | ||
| schema: | ||
| properties: | ||
| link: | ||
| type: string | ||
| '400': | ||
| description: Invalid parameters | ||
| '404': | ||
| description: Not found | ||
| '500': | ||
| description: Internal server error | ||
| default: | ||
| description: Unexpected error | ||
|
|
||
|
|
||
Empty file.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Все запросы лучше описать в одном файле