Initial commit
This commit is contained in:
42
src/swagger/endpoints/health.js
Normal file
42
src/swagger/endpoints/health.js
Normal file
@@ -0,0 +1,42 @@
|
||||
/**
|
||||
* Health endpoint Swagger configuration
|
||||
*/
|
||||
|
||||
export const healthEndpoint = {
|
||||
'/health': {
|
||||
get: {
|
||||
summary: 'Health check endpoint',
|
||||
description: 'Returns the status of the API',
|
||||
security: [
|
||||
{ ApiKeyAuth: [] },
|
||||
{ BearerAuth: [] }
|
||||
],
|
||||
responses: {
|
||||
'200': {
|
||||
description: 'API is running',
|
||||
content: {
|
||||
'application/json': {
|
||||
schema: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
status: {
|
||||
type: 'string',
|
||||
example: 'ok',
|
||||
},
|
||||
message: {
|
||||
type: 'string',
|
||||
example: 'Auth SecureChat API is running',
|
||||
},
|
||||
version: {
|
||||
type: 'string',
|
||||
example: '1.0.0',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
};
|
||||
Reference in New Issue
Block a user