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

Fix #663: Add Mobile Token documentation #670

Merged
merged 16 commits into from
Feb 13, 2023

Conversation

romanstrobl
Copy link
Member

No description provided.

@romanstrobl romanstrobl added the docs Documentation issue label Feb 13, 2023
@romanstrobl romanstrobl self-assigned this Feb 13, 2023
"amount": 100,
"currency": "CZK",
"amountFormatted": "100,00",
"currencyFormatted": "Kč"
Copy link
Member

@banterCZ banterCZ Feb 13, 2023

Choose a reason for hiding this comment

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

I will document this later on based on the result of discussion at #669

| `KEY_VALUE` | Form field representing a key value item, where items are displayed next to each other. This realistically impose limitation on value length - it should fit into the single line. |
| `NOTE` | Form field representing a generic text note, where label is displayed above the note. As a result, note can be of an arbitrary length and can be multi-line. |
| `HEADING` | Form field representing a heading, where label is displayed as the heading text. |
| `PARTY_INFO` | Form field representing a structured object with information about a third party. |
Copy link
Member

@banterCZ banterCZ Feb 13, 2023

Choose a reason for hiding this comment

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

I have opened an issue to document missing types #671


| Flag | Meaning |
|------|:-----------------------------|
| `B` | Operation can be signed with biometric factor |
Copy link
Member

Choose a reason for hiding this comment

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

If QR code documentation will be part of enrollment documentation, we should also document new flags introduced in 1.4.0; It may be another issue and PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think I will add it for now, just for the sake of having all documentation related to operation data (online / offline) and operation form data in one place. We can revise this later, if needed.

## Value Formatting

Following form data attributes support value formatting:
- `AMOUNT`
Copy link
Member

Choose a reason for hiding this comment

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

👀 #669 is focused only on the amount formatting.

Copy link
Member

@banterCZ banterCZ left a comment

Choose a reason for hiding this comment

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

Looks good in general. We may tune it up in consecutive PRs.

@romanstrobl romanstrobl merged commit 64df520 into develop Feb 13, 2023
@romanstrobl romanstrobl deleted the issues/663-mobile-token-documentation branch February 13, 2023 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants