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

docs update #55

Merged
merged 3 commits into from
May 1, 2024
Merged

docs update #55

merged 3 commits into from
May 1, 2024

Conversation

MitchellBarker
Copy link
Contributor

@MitchellBarker MitchellBarker commented Apr 30, 2024

Updated docs. Need to verify the following are good:

  • Removal of BaseConnection
  • Removal of PatchedExtendedAttributesRequest
  • Addition of /api/v3/accounts/{account_id}/oauth/authorize/{integration}/
  • Addition of /api/v3/accounts/{account_id}/oauth/callback/{integration}/

@MitchellBarker
Copy link
Contributor Author

@aaronbini mind confirming those oauth endpoints should be shown in the docs?

@aaronbini
Copy link
Contributor

@aaronbini mind confirming those oauth endpoints should be shown in the docs?

@MitchellBarker is this for public API docs? If so, those endpoints don't need to be added. They just get hit as part of the OAuth flow that gets kicked off in the UI.

@MitchellBarker
Copy link
Contributor Author

@aaronbini mind confirming those oauth endpoints should be shown in the docs?

@MitchellBarker is this for public API docs? If so, those endpoints don't need to be added. They just get hit as part of the OAuth flow that gets kicked off in the UI.

@aaronbini Yup! Just removed them then and tagged you in the related cloud PR :)

@@ -5843,61 +5859,6 @@ components:
required:
- filters
- pagination
PatchedExtendedAttributesRequest:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sidpatel13 @ericbaumann Just tagging to make sure this removal is correct. Haven't delved into why it's not being added now, since I assume one of yall know

Choose a reason for hiding this comment

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

I don't think we've made any changes here intentionally - i still see patch as a supported method on the detail view for EAT (link)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh we're actually good here. Turns out the body just changed to match the non-patch. The request and its docs didn't disappear.
Basically the docs generator was trying to be smart about making all parameters in the patch body optional - which isn't actually true for that route anyway. So should be fine to merge this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for checking!

@MitchellBarker MitchellBarker merged commit 7bf29ef into master May 1, 2024
6 of 8 checks passed
@MitchellBarker MitchellBarker deleted the mbarker/updating-docs branch May 1, 2024 14:53
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.

3 participants