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 new credentials endpoints and update part of old endpoints documentation #127

Merged
merged 3 commits into from
Jul 14, 2021

Conversation

ricardosantacattarina
Copy link
Member

No description provided.

@ricardosantacattarina
Copy link
Member Author

2 similar comments
@ricardosantacattarina
Copy link
Member Author

@ricardosantacattarina
Copy link
Member Author

Copy link
Contributor

@fabyan-alexander fabyan-alexander left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! But there are some points to review

  • We should not use {{url}} in our examples as we already use api.withleaf.io
  • The payload for all post endpoints is wrong, please review then
    There are also some other points marked in their respective place.

docs/user_management_endpoints.md Outdated Show resolved Hide resolved
docs/user_management_endpoints.md Outdated Show resolved Hide resolved
docs/user_management_endpoints.md Outdated Show resolved Hide resolved
docs/user_management_endpoints.md Outdated Show resolved Hide resolved
docs/user_management_endpoints.md Outdated Show resolved Hide resolved
```

</TabItem>
</Tabs>

### `GET /climate-field-view-credentials`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we include a deprecated tag in these headers? Something like a tag or a strikethrough

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first section talks about which endpoints are deprecated. For the body of the page, I think it is easier to restructure the whole page to separate deprecated endpoints from the new ones instead of tagging individually. But if you and/or product thinks every endpoint should have a tag I can add it, sure.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your right!

docs/user_management_endpoints.md Outdated Show resolved Hide resolved
docs/user_management_endpoints.md Outdated Show resolved Hide resolved
docs/user_management_endpoints.md Outdated Show resolved Hide resolved
docs/user_management_endpoints.md Outdated Show resolved Hide resolved
@ricardosantacattarina ricardosantacattarina merged commit cb187e1 into master Jul 14, 2021
@ricardosantacattarina ricardosantacattarina deleted the leaf-user-credentials-new-endpoints branch July 14, 2021 17:37
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

Successfully merging this pull request may close these issues.

2 participants