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

Update docs to include examples of request #17

Open
maxachis opened this issue Jun 6, 2024 · 0 comments
Open

Update docs to include examples of request #17

maxachis opened this issue Jun 6, 2024 · 0 comments

Comments

@maxachis
Copy link
Contributor

maxachis commented Jun 6, 2024

Docs can be made more accessible by including examples (in some programming or shell language) showing the requests in action. This will help make things easier for individuals in general but especially those new to making endpoint requests. Additionally, it will help make clear to both developers and users what the intended functionality is, making it easier to zero in on deviations. For example, we could provide:

import requests
import json

response = requests.post(
    "https://www.example.com/submit-form",
    data=json.dumps({"name": "John Doe", "age": 25}),
    headers={"Content-Type": "application/json"}
)

As an example for a submit-form endpoint.

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