Skip to content

Comments

Add WebhookBlock component#148

Draft
tjrobinson wants to merge 2 commits intoclearbank:mainfrom
tjrobinson:feature/webhooks
Draft

Add WebhookBlock component#148
tjrobinson wants to merge 2 commits intoclearbank:mainfrom
tjrobinson:feature/webhooks

Conversation

@tjrobinson
Copy link

@tjrobinson tjrobinson commented Jul 24, 2024

Adds a WebhookBlock component which uses JSON schema files for webhooks to generate documentation of the properties of each webhook.

An example of the manually generated documentation before this PR:

image

An example of the same documentation generated automatically using the new component:

image

Example URL for local testing:

http://localhost:8000/docs/embedded-banking/flexible-cash-isa#account-closure-completed-webhook

Tasks:

  • Add support for simple properties
  • Add support for nested objects
  • Re-instate the github block in src/templates/home.tsx

@tjrobinson tjrobinson marked this pull request as draft July 24, 2024 08:58
site {
siteMetadata {
title
docsLocation
}
}
github {
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was removed temporarily to allow it to run locally without needing to connect to GitHub. The parameters $repositoryName: String!, $repositoryOwner: String! were removed as a result. It should all be reverted before completing this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant