Skip to content

Commit

Permalink
fix up issues
Browse files Browse the repository at this point in the history
  • Loading branch information
@antony
antony committed Jul 19, 2023
1 parent bde06d5 commit 7e35cad
Show file tree
Hide file tree
Showing 3 changed files with 6,587 additions and 346 deletions.
20 changes: 10 additions & 10 deletions examples/routes.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,15 @@ export default [
id: Joi.string()
.required()
.description('The identifier of the customer to be retrieved.')
})
}),
query: Joi.object()
.pattern(
Joi.string().required().description('Ticket name'),
Joi.number().integer().required().min(1).description('Ticket quantity')
)
.min(1)
.required()
.description('Tickets requested')
},
plugins: {
'hapi-docs': {
Expand Down Expand Up @@ -219,17 +227,9 @@ export default [
options: {
description: 'Create a recipient',
notes: [
'Creates a new `Recipient` object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.'
'Creates a new `Recipient`. object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.'
],
tags: ['api'],
validate: {
query: Joi.object({
type: Joi.string()
.valid('bank', 'card')
.required()
.description('Type of the recipient’s payment method.')
})
},
plugins: {
'hapi-docs': {
order: 1
Expand Down
337 changes: 1 addition & 336 deletions examples/server.js
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { readFile } from 'node:fs/promises'
import Hapi from '@hapi/hapi'
import Inert from '@hapi/inert'

import exampleRoutes from './routes.js'
import pluginOptions from './pluginOptions.js'
import HapiDocs from '../lib/index.js'
Expand Down Expand Up @@ -39,341 +38,7 @@ async function initServer() {
options: pluginOptions
})

server.route([
{
method: 'POST',
path: '/customers',
handler() {
return ''
},
options: {
description: 'Create a customer',
notes: 'Creates a new customer object.',
tags: ['api'],
plugins: {
'hapi-docs': {
order: 1
}
}
}
},
{
method: 'GET',
path: '/customers/{id}',
handler() {
return ''
},
options: {
description: 'Retrieve a customer',
notes:
'Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.',
tags: ['api'],
validate: {
params: Joi.object({
id: Joi.string()
.required()
.description('The identifier of the customer to be retrieved.')
}),
query: Joi.object().pattern(
Joi.string().required().description('Ticket name'),
Joi.number().integer().required().min(1).description('Ticket quantity')
).min(1).required().description('Tickets requested')
},
plugins: {
'hapi-docs': {
order: 2
}
}
}
},
{
method: 'POST',
path: '/customers/{id}',
handler() {
return ''
},
options: {
description: 'Update a customer',
notes: [
'Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the **source** parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid source: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the `past_due` state, then the latest unpaid, unclosed invoice for the subscription will be retried (note that this retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice). (Note also that no invoices pertaining to subscriptions in the `unpaid` state, or invoices pertaining to canceled subscriptions, will be retried as a result of updating the customer’s source.)',
'This request accepts mostly the same arguments as the customer creation call.'
],
tags: ['api'],
validate: {
params: Joi.object({
id: Joi.string().required()
})
},
plugins: {
'hapi-docs': {
order: 3
}
}
}
},
{
method: 'DELETE',
path: '/customers/{id}',
handler() {
return ''
},
options: {
description: 'Delete a customer',
notes:
'Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.',
tags: ['api'],
validate: {
params: Joi.object({
id: Joi.string()
.required()
.description('The identifier of the customer to be deleted.')
})
},
plugins: {
'hapi-docs': {
order: 4
}
}
}
},
{
method: 'GET',
path: '/customers',
handler() {
return ''
},
options: {
description: 'List all customers',
notes:
'Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.',
tags: ['api'],
plugins: {
'hapi-docs': {
order: 5
}
}
}
},
{
method: 'POST',
path: '/refunds',
handler() {
return ''
},
options: {
description: 'Create a refund',
notes: [
'When you create a new refund, you must specify a charge to create it on.',
'Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.',
'You can optionally refund only part of a charge. You can do so as many times as you wish until the entire charge has been refunded.',
'Once entirely refunded, a charge can’t be refunded again. This method will return an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.'
],
tags: ['api'],
validate: {
payload: Joi.object({
id: Joi.string()
.required()
.description('The identifier of the charge to refund.'),
amount: Joi.number()
.integer()
.positive()
.default(100)
.description(
'A positive integer representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.'
)
})
},
plugins: {
'hapi-docs': {
order: 1
}
}
}
},
{
method: 'GET',
path: '/refunds/{id}',
handler() {
return ''
},
options: {
description: 'Retrieve a refund',
notes: 'Retrieves the details of an existing refund.',
tags: ['api'],
validate: {
params: Joi.object({
id: Joi.string()
.required()
.description('The identifier of the refund to be retrieved.')
})
},
plugins: {
'hapi-docs': {
order: 2
}
}
}
},
{
method: 'POST',
path: '/refunds/{id}',
handler() {
return ''
},
options: {
description: 'Update a refund',
notes: [
'Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.',
'This request only accepts `metadata` as an argument.'
],
tags: ['api'],
validate: {
params: Joi.object({
id: Joi.string().required()
})
},
plugins: {
'hapi-docs': {
order: 3
}
}
}
},
{
method: 'GET',
path: '/refunds',
handler() {
return ''
},
options: {
description: 'List all refunds',
notes:
'Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.',
tags: ['api'],
plugins: {
'hapi-docs': {
order: 4
}
}
}
},
{
method: 'POST',
path: '/recipients',
handler() {
return ''
},
options: {
description: 'Create a recipient',
notes: [
'Creates a new `Recipient`. object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.'
],
tags: ['api'],
plugins: {
'hapi-docs': {
order: 1
}
}
}
},
{
method: 'GET',
path: '/recipients/{id}',
handler() {
return ''
},
options: {
description: 'Retrieve a recipient',
notes:
'Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.',
tags: ['api'],
validate: {
params: Joi.object({
id: Joi.string()
.required()
.description('The identifier of the recipient to be retrieved.')
})
},
plugins: {
'hapi-docs': {
order: 2
}
}
}
},
{
method: 'POST',
path: '/recipients/{id}',
handler() {
return ''
},
options: {
description: 'Update a recipient',
notes: [
'Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.',
'If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.'
],
tags: ['api'],
validate: {
params: Joi.object({
id: Joi.string().required()
})
},
plugins: {
'hapi-docs': {
order: 3
}
}
}
},
{
method: 'DELETE',
path: '/recipients/{id}',
handler() {
return ''
},
options: {
description: 'Delete a recipient',
notes: 'Permanently deletes a recipient. It cannot be undone.',
tags: ['api'],
validate: {
params: Joi.object({
id: Joi.string()
.required()
.description('The identifier of the recipient to be deleted.')
})
},
plugins: {
'hapi-docs': {
order: 4
}
}
}
},
{
method: 'GET',
path: '/recipients',
handler() {
return ''
},
options: {
description: 'List all recipients',
notes:
'Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.',
tags: ['api'],
plugins: {
'hapi-docs': {
order: 5
}
}
}
}
])

await server.start()

// eslint-disable-next-line
console.log(`${name} (v.${version}) server listening on ${server.info.uri}`)
return server
}

// eslint-disable-next-line
Expand Down
Loading

0 comments on commit 7e35cad

Please sign in to comment.