ERROR: TypeError: Cannot read property 'schema' of undefined #324
Comments
|
@softmantk this fails a bit spectacularly, but ultimately the error is due to the route logic change app.use('/api/v1/meeting/{meetingId}', (req, res) => { // <-- {meetingId} should be :meetingId
return res.send("success")
});to app.use('/api/v1/meeting/:meetingId', (req, res) => {
return res.send("success")
});Also, you yaml is a bit off /api/v1/meeting/{meetingId}:
get:
description: Get meeting details by meeting id
summary: Get meeting details by meeting id
tags:
- Meeting
parameters:
## change
# - name: meetingId
# in: path
# required: true
# description: Meeting id
# schema:
# $ref: '#/components/parameters/MeetingId'
## to
- $ref: '#/components/parameters/MeetingId'
responses:
'200':
description: Meeting token obtained successfully
content:
application/json:
schema:
$ref: '#/components/parameters/MeetingId'Then this should return success |
|
To fix your example, replace these two files openapi: 3.0.0
info:
title: Manual Handling
description: API documentation for manual handling.
version: 0.1.9
servers:
- url: /
description: Self
- url: http://localhost:3010
description: local
- url: https://mhcore.quinoid.in
description: Development server
paths:
/ping:
get:
description: Check server connectivity
summary: ping pong
responses:
'200':
description: OK
content:
text/plain:
schema:
type: string
example: pong
/api/v1/meeting/{meetingId}:
get:
description: Get meeting details by meeting id
summary: Get meeting details by meeting id
tags:
- Meeting
parameters:
- $ref: '#/components/parameters/MeetingId'
responses:
'200':
description: Meeting token obtained successfully
content:
application/json:
schema:
$ref: '#/components/parameters/MeetingId'
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
parameters:
MeetingId:
name: meetingId
description: Meeting id of the session
required: true
in: path
example: 01701deb-34cb-46c2-972d-6eeea3850342
schema:
type: stringapp.js
const createError = require('http-errors');
const express = require('express');
const path = require('path');
const cookieParser = require('cookie-parser');
const logger = require('morgan');
const { OpenApiValidator } = require('express-openapi-validator');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
const swaggerDocument = YAML.load('./swagger.yaml');
const cors = require('cors');
const app = express();
app.use(logger('dev'));
app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.use(cookieParser());
app.use(cors());
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
const spec = path.join(__dirname, 'swagger.yaml');
new OpenApiValidator({
apiSpec: spec,
// validateResponses: true,
validateRequests: true,
}).installSync(app);
app.use('/api/v1/meeting/:meetingId', (req, res) => {
return res.send('success');
});
// catch 404 and forward to error handler
app.use(function (req, res, next) {
next(createError(404));
});
// error handler
app.use((err, req, res, next) => {
// format error
console.log(err);
res.status(err.status || 500).json({
message: err.message,
errors: err.errors,
});
});
app.listen(3000, () => {
console.log('App listening');
});
module.exports = app; |
cdimascio
added a commit
that referenced
this issue
Jun 24, 2020
|
i have a PR that fixes the undefined schema and reports an appropriate error |
|
fixed in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
I am getting
ERROR: TypeError: Cannot read property 'schema' of undefined
for a very simple api documentation.
To Reproduce
Steps to reproduce the behavior.
Documentation:
TO REPRODUCE:
https://github.com/softmantk/open-api-issue-324.git
http://localhost:3000/api-docs/#/Meeting/get_api_v1_meeting__meetingId_
4. Will be getting internal error : ERROR: TypeError: Cannot read property 'schema' of undefined
Actual behavior
Getting error:
Expected behavior
Without any error, do validation and throw validation if exist.
API Documentation is verified in the swagger editor. It didnt throw any errors
Examples and context
An example or relevant context e.g. an OpenAPI snippet, an Express handler function snippet
The text was updated successfully, but these errors were encountered: