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

API specification documentation #1

Open
7 of 8 tasks
AdebayoEmmanuel opened this issue Mar 17, 2024 · 0 comments
Open
7 of 8 tasks

API specification documentation #1

AdebayoEmmanuel opened this issue Mar 17, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@AdebayoEmmanuel
Copy link
Member

AdebayoEmmanuel commented Mar 17, 2024

Create a Notion documentation for the API specification following this guideline:

On the notion page, create sections with the following headings:

  • Architecture: image of our solutions architecture and expected flow of data
  • APIs and Methods:
  • List and describe the API routes that we will be creating for our client to communicate with our API with their accepted options.
  • List and describe any API function/methods used in implementing our logic.
  • List and describe any 3rd party APIs that we will be using.
  • Schema: a JSON representation of what a notification looks like with data types stored as value for property key.

NB: As we build the project further and run tests on the system, add examples to show the technical specification in action, this way we document every new thing we add and test.

@AdebayoEmmanuel AdebayoEmmanuel added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants