Skip to content

Add an exclude param #3

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
brunoMaurice wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add an exclude param #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@ ParseSwagger.prototype.renderSwaggerSpec = function (req, res) {
headers: { "X-Parse-Application-Id": this.config.appId, "X-Parse-Master-Key": this.config.masterKey }
};

var excludes = this.config.excludes || [];

request(options).then((data) => {
var swagger = parseSchemaToSwagger(parseBaseSwaggerSpec, data.results);
var swagger = parseSchemaToSwagger(parseBaseSwaggerSpec, data.results, excludes);
res.json(swagger);
}).catch((error) => {
res.send('Request failed with response code ' + error.status);
Expand Down
1 change: 1 addition & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ if (CONFIG.swagger) {
parsePath: '/parse'
appId: '<appId>',
masterKey: '<masterKey>',
excludes: ['className'],
});

app.use(parseSwagger);
Expand Down
6 changes: 5 additions & 1 deletion schema-to-swagger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
/**
* Transform Parse Server schema.json to swagger.json
*/
exports.parseSchemaToSwagger = function (spec, schemas) {
exports.parseSchemaToSwagger = function (spec, schemas, excludes) {
for (const classes of schemas) {
if (excludes.includes(classes.className)) {
continue;
}

spec.components.schemas[classes.className] = transformClasseToSchema(classes);
spec.paths['/parse/classes/' + classes.className] = getPath(classes);
spec.paths['/parse/classes/' + classes.className + '/{id}'] = getPathById(classes);
Expand Down