Skip to content

Minor documentation fixes #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JaredCE wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Minor documentation fixes #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4358241
all fields in contact obj are optional
JaredCE Jan 4, 2026
103d930
only add ehaders if there are any
JaredCE Jan 4, 2026
86efbed
check the length
JaredCE Jan 4, 2026
ccf8c71
improved handling of multiple contentTypes
JaredCE Jan 4, 2026
5c46818
correctly handle multiple media types
JaredCE Jan 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 45 additions & 38 deletions src/definitionGenerator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,12 @@ class DefinitionGenerator {

if (documentation.contact) {
const contactObj = {};
contactObj.name = documentation.contact.name || "";

if (documentation.contact.name) contactObj.name = documentation.contact.name;

if (documentation.contact.url) contactObj.url = documentation.contact.url;

contactObj.email = documentation.contact.email || "";
if (documentation.contact.email) contactObj.email = documentation.contact.email;

const extendedSpec = this.extendSpecification(documentation.contact);

Expand Down Expand Up @@ -591,7 +592,9 @@ class DefinitionGenerator {
obj.headers = corsHeaders;
addHeaders(owaspHeaders);
} else {
obj.headers = owaspHeaders;
if (Object.keys(owaspHeaders).length){
obj.headers = owaspHeaders;
}
}
}

Expand Down Expand Up @@ -677,7 +680,7 @@ class DefinitionGenerator {

async createRequestBody(requestBodyDetails) {
const obj = {
description: requestBodyDetails.description,
description: requestBodyDetails.description || '',
required: requestBodyDetails.required || false,
};

Expand All @@ -692,56 +695,60 @@ class DefinitionGenerator {

async createMediaTypeObject(models, type) {
const mediaTypeObj = {};

for (const mediaTypeDocumentation of this.schemaHandler.models) {
if (models === undefined || models === null) {
throw new Error(
`${this.currentFunctionName} is missing a Response Model for statusCode ${this.currentStatusCode}`
);
}

if (Object.values(models).includes(mediaTypeDocumentation.name)) {
let contentKey = "";
for (const [key, value] of Object.entries(models)) {
if (value === mediaTypeDocumentation.name) contentKey = key;
for (const modelContentType in models) {
let contentKey

if (models[modelContentType] === mediaTypeDocumentation.name) {
contentKey = modelContentType;
}
const obj = {};

let schema;
if (mediaTypeDocumentation?.content) {
if (mediaTypeDocumentation.content[contentKey]?.example)
obj.example = mediaTypeDocumentation.content[contentKey].example;
if (contentKey) {

if (mediaTypeDocumentation.content[contentKey]?.examples)
obj.examples = this.createExamples(
mediaTypeDocumentation.content[contentKey].examples
);
const obj = {};
let schema;
if (mediaTypeDocumentation.content) {
if (mediaTypeDocumentation.content[contentKey]?.example) {
obj.example = mediaTypeDocumentation.content[contentKey]?.example;
}

schema = mediaTypeDocumentation.content[contentKey].schema;
} else if (
mediaTypeDocumentation?.contentType &&
mediaTypeDocumentation.schema
) {
if (mediaTypeDocumentation?.example)
obj.example = mediaTypeDocumentation.example;
if (mediaTypeDocumentation.content[contentKey]?.examples) {
obj.examples = this.createExamples(
mediaTypeDocumentation.content[contentKey].examples
);
}

if (mediaTypeDocumentation?.examples)
obj.examples = this.createExamples(mediaTypeDocumentation.examples);
schema = (mediaTypeDocumentation.schema) ? mediaTypeDocumentation.schema : mediaTypeDocumentation.schemas[contentKey];
} else if (mediaTypeDocumentation?.contentType && mediaTypeDocumentation.schema) {
if (mediaTypeDocumentation.example) {
obj.example = mediaTypeDocumentation.example;
}

schema = mediaTypeDocumentation.schema;
}
if (mediaTypeDocumentation.examples) {
obj.example = mediaTypeDocumentation.examples;
}

const schemaRef = await this.schemaHandler
.createSchema(mediaTypeDocumentation.name)
.catch((err) => {
throw err;
});
schema = mediaTypeDocumentation.schema;
}

obj.schema = {
$ref: schemaRef,
};
const schemaRef = await this.schemaHandler
.createSchema(mediaTypeDocumentation.name)
.catch((err) => {
throw err;
});

Object.assign(mediaTypeObj, { [contentKey]: obj });
obj.schema = {
$ref: schemaRef,
};

Object.assign(mediaTypeObj, { [contentKey]: obj });
}
}
}

Expand Down
94 changes: 58 additions & 36 deletions src/schemaHandler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,21 @@ class SchemaHandler {
return model;
}

const contentType = Object.keys(model.content)[0];
model.contentType = contentType;
model.schema = model.content[contentType].schema;
if (Object.keys(model.content).length === 1) {
const contentType = Object.keys(model.content)[0];
model.contentType = contentType;
model.contentTypes = [contentType];
model.schema = model.content[contentType].schema;
} else {
model.contentType = null;
model.contentTypes = Object.keys(model.content);
model.schema = null;
model.schemas = {};
for (const key in model.content) {
Object.assign(model.schemas, {[key]: {schema: model.content[key].schema}});
}
// model.schema = model.content[contentType].schema;
}

return model;
};
Expand All @@ -69,43 +81,53 @@ class SchemaHandler {
async addModelsToOpenAPI() {
for (const model of this.models) {
const modelName = model.name;
const modelSchema = model.schema;
const schemas = []
if (model.schema){
// const modelSchema = model.schema;
schemas.push(model.schema)
} else {
for (const key in model.schemas) {
schemas.push(model.schemas[key].schema);
}
}

const convertedSchemas = await this.__dereferenceAndConvert(
modelSchema,
modelName,
model
).catch((err) => {
if (err instanceof Error) throw err;
else return err;
});
for (const modelSchema of schemas) {
const convertedSchemas = await this.__dereferenceAndConvert(
modelSchema,
modelName,
model
).catch((err) => {
if (err instanceof Error) throw err;
else return err;
});

if (
typeof convertedSchemas.schemas === "object" &&
!Array.isArray(convertedSchemas.schemas) &&
convertedSchemas.schemas !== null
) {
for (const [schemaName, schemaValue] of Object.entries(
convertedSchemas.schemas
)) {
if (schemaName === modelName) {
this.modelReferences[
schemaName
] = `#/components/schemas/${modelName}`;
}

if (
typeof convertedSchemas.schemas === "object" &&
!Array.isArray(convertedSchemas.schemas) &&
convertedSchemas.schemas !== null
) {
for (const [schemaName, schemaValue] of Object.entries(
convertedSchemas.schemas
)) {
if (schemaName === modelName) {
this.modelReferences[
schemaName
] = `#/components/schemas/${modelName}`;
this.__addToComponents("schemas", schemaValue, schemaName);
}

this.__addToComponents("schemas", schemaValue, schemaName);
} else {
throw new Error(
`There was an error converting the ${
model.name
} schema. Model received looks like: \n\n${JSON.stringify(
model
)}. The convereted schema looks like \n\n${JSON.stringify(
convertedSchemas
)}`
);
}
} else {
throw new Error(
`There was an error converting the ${
model.name
} schema. Model received looks like: \n\n${JSON.stringify(
model
)}. The convereted schema looks like \n\n${JSON.stringify(
convertedSchemas
)}`
);
}
}
}
Expand Down