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

Add documentation around api payloads #33

Open
ianco opened this issue Feb 15, 2023 · 0 comments
Open

Add documentation around api payloads #33

ianco opened this issue Feb 15, 2023 · 0 comments

Comments

@ianco
Copy link

ianco commented Feb 15, 2023

The payloads for some api endpoints (for example /v4/topic/{id}/credential-set) are fairly complicated and difficult to interpret for someone who is not familiar with the orgbook data model and how credentials are issued, received and processed.

Add some documentation to this site to explain:

  • the core orgbook credentials (registration, business number, relationship)
  • how credential history works
  • how data is presented in payloads and how to look up the credential attribute values
  • how to request active creds only, history, etc
  • how to use id's from one endpoint as a filter for another endpoint (e.g. look up a company and then find credentials for that company)
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

No branches or pull requests

1 participant