Skip to content

chore: Add OpenAPI 3 document #36

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
duncanbeevers wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

chore: Add OpenAPI 3 document #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5393c7c
chore: Add OpenAPI 3 document
duncanbeevers May 18, 2023
1cae81a
feat: Remove verify_password field
duncanbeevers May 18, 2023
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,9 @@ Delete an event:

## API Documentation
API Swagger documentation can be accessed from the docker host machine: `http://localhost:3004/documentation`
Schema documents are available in OpenAPI v2 and v3 flavors.
* OpenAPI v2 Schema (Swagger) `http://localhost:3004/swagger.json`
* OpenAPI v3 Schema `http://localhost:3004/openapi.json`

## Heroku Deploy

Expand Down
8 changes: 8 additions & 0 deletions config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,14 @@ module.exports = {
admin_email: process.env.ADMIN_EMAIL || 'info@heatsynclabs.org',
domain: process.env.DOMAIN_LOCATION || 'http://localhost:3005',
domain_dev: process.env.DOMAIN_LOCATION_DEV || 'http://localhost:3005',
openapiOptions: {
info: {
title: Pack.name,
description: Pack.description + ' - ' + env,
version: Pack.version,
},
pathPrefixSize: 3,
},
server_url: process.env.SERVER_URL || `http://localhost:${port}`,
swaggerOptions: {
info: {
Expand Down
11 changes: 9 additions & 2 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const Hapi = require('@hapi/hapi');
const Inert = require('@hapi/inert');
const Vision = require('@hapi/vision');
const JWTAuth = require('hapi-auth-jwt2');
const HapiOpenapi3 = require('hapi-openapi3');
const HapiSwagger = require('hapi-swagger');
const CookieAuth = require('@hapi/cookie');
const debug = require('debug')('errors');
Expand All @@ -41,10 +42,16 @@ async function start() {
JWTAuth,
Inert,
Vision,
{
plugin: HapiOpenapi3,
options: {
...config.openapiOptions,
includeFn: () => true,
}
},
{
plugin: HapiSwagger,
// eslint-disable-next-line
options: config.swaggerOptions
options: config.swaggerOptions,
},
]);
} catch (error) {
Expand Down
94 changes: 63 additions & 31 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@
"custom-error": "^0.2.1",
"debug": "^4.3.4",
"hapi-auth-jwt2": "^10.2.0",
"hapi-swagger": "^15.0.0",
"hapi-openapi3": "^1.0.9",
"hapi-swagger": "^16.0.1",
"joi": "^17.7.0",
"jsonwebtoken": "^9.0.0",
"knex": "^2.3.0",
Expand Down
3 changes: 1 addition & 2 deletions routes/users.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,7 @@ module.exports = [
token: Joi.string().uuid().required(),
}),
payload: Joi.object({
password: Joi.string().regex(/^[a-zA-Z0-9]{6,1000}$/).required(),
verify_password: Joi.any().valid(Joi.ref('password')).required()
password: Joi.string().regex(/^[a-zA-Z0-9]{6,1000}$/).required()
})
},
},
Expand Down