Skip to content
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.

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

docs: fixes 3084 #3088

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

docs: fixes 3084 #3088

wants to merge 2 commits into from

Conversation

melissahenderson
Copy link
Contributor

@melissahenderson melissahenderson commented Nov 6, 2024

This PR covers doc issues that were discussed during a meeting with Max on Nov. 05, 2024.

@mkurapov Tagging you because of the YAML updates. Also, the OpenAPI spec for IdP is missing Continue Grant POST /interact/{id}/{nonce}. Is that intentional or should I create an issue for it?

@github-actions github-actions bot added pkg: backend Changes in the backend package. type: source Changes business logic pkg: auth Changes in the GNAP auth package. pkg: documentation Changes in the documentation package. labels Nov 6, 2024
Copy link

netlify bot commented Nov 6, 2024

Deploy Preview for brilliant-pasca-3e80ec ready!

Name Link
🔨 Latest commit c884630
🔍 Latest deploy log https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/672cbfab0bbc0000080bf47f
😎 Deploy Preview https://deploy-preview-3088--brilliant-pasca-3e80ec.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mkurapov
Copy link
Contributor

mkurapov commented Nov 6, 2024

Also, the OpenAPI spec for IdP is missing Continue Grant POST /interact/{id}/{nonce}. Is that intentional or should I create an issue for it?

Continue Grant POST is for the Open Payments Auth API, so shouldn't be in the IdP spec

packages/backend/src/openapi/specs/webhooks.yaml Outdated Show resolved Hide resolved
packages/backend/src/openapi/specs/webhooks.yaml Outdated Show resolved Hide resolved
@@ -194,11 +193,11 @@ Open Payments <LinkOut href="https://openpayments.dev/apis/wallet-address-server

<div class="overflow-table">

| Parameter | Required value | Description |
Copy link
Contributor

Choose a reason for hiding this comment

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

was this auto-formatted?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When we run prettier on the docs, it adds a bunch of extra spaces within all the markdown table columns and rows. That makes it harder for the writers to 'read' the tables and edit them later. Sarah's given us a temporary workaround where prettier will ignore the tables (actually, maybe all the doc files) and keep our original formatting. So this was me putting the table back to its original formatting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: auth Changes in the GNAP auth package. pkg: backend Changes in the backend package. pkg: documentation Changes in the documentation package. type: source Changes business logic
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants