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 Examples for API Calls #1

Open
6 tasks
realTimothyJLos opened this issue Jun 2, 2023 · 0 comments
Open
6 tasks

Add Examples for API Calls #1

realTimothyJLos opened this issue Jun 2, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@realTimothyJLos
Copy link
Member

realTimothyJLos commented Jun 2, 2023

Description

We need to add examples for API calls in the documentation to provide clear usage guidelines for the FYS SDK. This will help users understand how to make API requests using the SDK and handle the responses.

Tasks

  • Create a new section in the README.md file dedicated to API call examples.
  • Provide code snippets and explanations for common API calls, such as GET, POST, and PUT requests.
  • Include sample requests and responses to showcase the expected format and data.
  • Ensure that the examples cover various use cases and scenarios.
  • Review and refine the examples to ensure accuracy and clarity.
  • Update the README.md file with the new examples section.

Additional Information

  • SDK Version: [Specify the version of the SDK where the examples will be added]
  • Target Audience: [Specify the intended audience for the examples, such as developers integrating with the FYS API]
  • Deadline: [Specify the desired deadline for completing this task]
@realTimothyJLos realTimothyJLos added the documentation Improvements or additions to documentation label Jun 2, 2023
@realTimothyJLos realTimothyJLos self-assigned this Jun 2, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant