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.

Sign up for GitHub

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

Jump to bottom

Add an API layout #11

Open
johnnymatthews opened this issue Dec 6, 2022 · 0 comments
Open

Add an API layout #11

johnnymatthews opened this issue Dec 6, 2022 · 0 comments
Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week P2 Medium: Good to have, but can wait until someone steps up

Comments

@johnnymatthews
Copy link
Contributor

johnnymatthews commented Dec 6, 2022 •
edited
Loading

It'd be nice to have a build in API layout within this template. Each method needs to contain:

  • Comments on the left.
  • Code on the right.
  • Inputs with types and descriptions.
  • Outputs with types and descriptions.
  • Example Curl request.
  • Example output from Curl request.
@johnnymatthews johnnymatthews added dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week P2 Medium: Good to have, but can wait until someone steps up labels Dec 29, 2022
@github-project-automation github-project-automation bot moved this to 👣 Needs triage in Protocol Docs Apr 4, 2023
@johnnymatthews johnnymatthews moved this from 👣 Needs triage to 📋 Backlog in Protocol Docs Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week P2 Medium: Good to have, but can wait until someone steps up
Projects
Protocol Docs
Status: 📋 Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@johnnymatthews