influxdata / influxdata/openapi
Document basic vs system handling of task script parameters
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 18
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Test and document this, add response examples to cloud/paths/tasks.
Will
type=basicinclude thescriptIDandscriptParametersor send them empty as well?
I'm not certain, but those fields will likely be sent back as well, if they are set. I know they are tagged omitempty which means the field will not be returned if it's not set (something easily changeable if desired)
Originally posted by @glinton in https://github.com/influxdata/openapi/issues/349#issuecomment-1183702229
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect cloud/paths/tasks and test the basic and system handling of task script parameters, especially scriptID and scriptParameters. Add response examples documenting whether these fields are returned when set and omitted when unset; done means the behavior is tested and the examples are present.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100