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

Document the HTTP action provider #102

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

kurtmckee
Copy link
Member

This branch adds documentation for the upcoming HTTP action provider, including:

  • The URL and scope
  • Complete documentation of all input document keys and values
  • Examples of usage
  • Documentation of the errors that may be returned by the HTTP action provider, including suggestions for how to resolve the errors.

[sc-11704]

@kurtmckee kurtmckee added the documentation Improvements or additions to documentation label Nov 12, 2021
@kurtmckee kurtmckee self-assigned this Nov 12, 2021
Copy link
Contributor

@urimandujano urimandujano left a comment

Choose a reason for hiding this comment

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

These docs read really well and set the goal for where we want all our AP documentation to get to. I'd personally use this as a template to fill in the details on the other APs. My comments are opinions on reducing duplicated information but if you feel strongly about keeping as is I'm ok with that.

docs/source/globus_action_providers.rst Outdated Show resolved Hide resolved
docs/source/globus_action_providers.rst Outdated Show resolved Hide resolved
@kurtmckee
Copy link
Member Author

Note that the changes in b6defdd depend on https://github.com/globusonline/globus-automate/pull/218.

Copy link
Contributor

@urimandujano urimandujano left a comment

Choose a reason for hiding this comment

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

Thanks Kurt! Thanks for mentioning that this relies on #218 -- let's hold off on merging this to master until we cut that PR in a release, otherwise we'll be out of sync with what is actually deployed.

@kurtmckee
Copy link
Member Author

Updated to remove references to the user-configurable timeout key (which is no longer supported) and to document the new HTTP response size and total timeout errors.

@kurtmckee kurtmckee marked this pull request as draft December 2, 2021 17:23
@kurtmckee
Copy link
Member Author

The HTTP action provider is currently for internal use. Once this restriction is lifted this can be reviewed and merged.

@kurtmckee kurtmckee requested review from urimandujano and removed request for seren, jimPruyne and urimandujano December 20, 2022 18:59
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

Successfully merging this pull request may close these issues.

2 participants