Skip to content
This repository has been archived by the owner on Mar 8, 2024. It is now read-only.

Schemas page #77

Open
0xASK opened this issue Jun 29, 2020 · 5 comments
Open

Schemas page #77

0xASK opened this issue Jun 29, 2020 · 5 comments

Comments

@0xASK
Copy link
Collaborator

0xASK commented Jun 29, 2020

Currently, we have a page named payid-schemas living under the PayID Protocol section. Given that the schemas are an artifact of our reference implementation, they should at minimum be moved to the Reference Implementation. However, it appears that we only have 1 schema here and link to https://api.payid.org/?version=latest.

Opening this to get some input, should we delete this whole page and just let people explore the schemas as they're exploring the API at https://api.payid.org/?version=latest or should we migrate it under the Reference Implementation section?

If we migrate it under the Reference Implementation section do we want to leave it as is or do we want to add the rest of the schemas?

@Stormtv @ryangyoung

@Stormtv
Copy link
Collaborator

Stormtv commented Jun 29, 2020

I would prefer to get rid of api.payid.org and implement it in a Live Code editor within the documentation.

similar to https://v2.docusaurus.io/docs/markdown-features/#interactive-code-editor

In regards to the schema I'm cool with moving it and expanding it to have more content

@0xCLARITY
Copy link
Contributor

I would prefer to get rid of api.payid.org and implement it in a Live Code editor within the documentation.

What would you make a live code editor? Most of the functionality is just HTTP requests, right?

should we delete this whole page and just let people explore the schemas as they're exploring the API at api.payid.org/?version=latest

I'm down to delete that page.

@ryangyoung
Copy link
Collaborator

@hbergren @Stormtv Does that live code editor work with an Open API spec?

Also, maybe we should take a step back and consider:

  • Who is the audience for the information?
  • What will they be doing with it?
  • What is the source of the information?
  • How frequently do we expect the information to change? (This is why I'd advocate for sourcing the definition from the code if at all possible.)
  • What do we expect users to do with the information? i.e. do we want them to try out API requests? Just copy/paste schemas into their implmentation?

@sappenin
Copy link
Collaborator

@ryangyoung just bumping this issue - is there room to address the immediate concern here, and then create other tasks to address your ideas/concerns?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants
@sappenin @Stormtv @ryangyoung @0xASK @0xCLARITY and others