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 config parameters in plugins #1286

Open
35 tasks done
alambare opened this issue Aug 6, 2024 · 1 comment · May be fixed by #1297
Open
35 tasks done

Document config parameters in plugins #1286

alambare opened this issue Aug 6, 2024 · 1 comment · May be fixed by #1297
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@alambare
Copy link
Collaborator

alambare commented Aug 6, 2024

Is your feature request related to a problem? Please describe.
Add docstring documentation for config parameters available in each plugin.

Describe the solution you'd like
Use docstring to document the parameters available for each plugin.
Should be described for each parameter:

  • the parameter name
  • a description explaining what is it for, what does it do
  • format and type of expected value
  • whether it is optional or mandatory
  • default value

plugins to cover:

Api

  • EcmwfApi
  • UsgsApi

Authentication

  • AwsAuth
  • GenericAuth
  • HTTPHeaderAuth
  • KeycloakOIDCPasswordAuth
  • OAuth
  • OIDCRefreshTokenBase
  • OIDCAuthorizationCodeFlowAuth
  • HttpQueryStringAuth
  • QueryStringAuth
  • RequestsSASAuth
  • SASAuth
  • TokenAuth
  • OIDCTokenExchangeAuth

Crunch

  • FilterDate
  • FilterLatestIntersect
  • FilterLatestByName
  • FilterOverlap
  • FilterProperty

Download

  • AwsDownload
  • CreodiasS3Download
  • HTTPDownload
  • S3RestDownload

Search

  • BuildPostSearchResult
  • BuildSearchResult
  • CopMarineSearch
  • CreodiasS3Search
  • CSWSearch
  • DataRequestSearch
  • QueryStringSearch
  • ODataV4Search
  • PostJsonSearch
  • StacSearch
  • StaticStacSearch
@alambare alambare added the documentation Improvements or additions to documentation label Aug 6, 2024
@jlahovnik jlahovnik self-assigned this Aug 7, 2024
@jlahovnik jlahovnik linked a pull request Aug 14, 2024 that will close this issue
@jlahovnik
Copy link
Collaborator

Is your feature request related to a problem? Please describe. Add docstring documentation for config parameters available in each plugin.

Describe the solution you'd like Use docstring to document the parameters available for each plugin. Should be described for each parameter:

* the parameter name

* a description explaining what is it for, what does it do

* format and type of expected value

* whether it is optional or mandatory

* default value

plugins to cover:

Api

* [x]  EcmwfApi

* [x]  UsgsApi

Authentication

* [x]  AwsAuth

* [x]  GenericAuth

* [x]  HTTPHeaderAuth

* [x]  KeycloakOIDCPasswordAuth

* [x]  OAuth

* [x]  OIDCRefreshTokenBase

* [x]  OIDCAuthorizationCodeFlowAuth

* [x]  HttpQueryStringAuth

* [x]  QueryStringAuth

* [x]  RequestsSASAuth

* [x]  SASAuth

* [x]  TokenAuth

* [x]  OIDCTokenExchangeAuth

Crunch

* [x]  FilterDate

* [x]  FilterLatestIntersect

* [x]  FilterLatestByName

* [x]  FilterOverlap

* [x]  FilterProperty

Download

* [x]  AwsDownload

* [x]  CreodiasS3Download

* [x]  HTTPDownload

* [x]  S3RestDownload

Search

* [x]  BuildPostSearchResult

* [x]  BuildSearchResult

* [x]  CopMarineSearch

* [x]  CreodiasS3Search

* [x]  CSWSearch

* [x]  DataRequestSearch

* [x]  QueryStringSearch

* [x]  ODataV4Search

* [x]  PostJsonSearch

* [x]  StacSearch

* [x]  StaticStacSearch

NOTE: RequestsSASAuth and QueryStringAuth aren't plugins and therefore don't have a config

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 a pull request may close this issue.

2 participants