influxdata / influxdata/openapi
docs: fix script description
- Dominant language
- Shell
- Stars
- 18
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
```suggestion
In the request body, provide the script properties to update.
```
This is my new pattern. Eventually, I plan to append an statement (with redoc-cli) that introduces the properties that can be set, like in YouTube docs--"You can set the following properties for this resource:"
_Originally posted by @jstirnaman in https://github.com/influxdata/openapi/pull/444#discussion_r1014518695_
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the request-body description discussed in pull request #444 and locate the corresponding script resource in the OpenAPI specification. Update the description to clarify that the request body contains script properties to update, then verify the rendered documentation with redoc-cli.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100