API endpoint change detected
Source PR: mock
Changed endpoints
[
{
"method": "GET",
"path": "/api/v1/projects/{id}/members",
"change_type": "added",
"auth": [
"userApiToken"
],
"summary": "Returns members of a project"
}
]
Change type guide
added: create a new CLI command and register it
modified: update the existing command, parameters and/or output handling
removed: deprecate and delete the existing CLI command gracefully
refactored: update internals only - keep the CLI interface identical
What to implement
- Increment the patch version in
cloudos_cli/_version.py (currently: __version__ = '2.91.0')
- Add a CHANGELOG entry at the top of
CHANGELOG.md matching the existing format
- Create or modify the relevant module file under
cloudos_cli/<module>/
- Commands live in
cloudos_cli/clos.py or module files like cloudos_cli/jobs/job.py
- There is no
cloudos_cli/commands/ directory - do not create one
- Write at least 2 unit tests in
tests/ using pytest + responses + mock
- Update
supported-endpoints.json to reflect the change
Relevant existing manifest entries
[
{
"id": "projects-create",
"method": "POST",
"path": "/api/v1/projects",
"query_params": [
"teamId"
],
"cli_command": "cloudos project create",
"source_file": "cloudos_cli/clos.py",
"added_in_version": "2.91.0",
"notes": null
}
]
Recent changelog (match this format exactly)
- Changes `--job-params` to `--job-config`
- Removes the collection of the `project.description` column from the
returned json when listing all jobs, as this column is not available
in all the CloudOS workspaces.
### 0.0.3 - 2021-09-08
- Adds `cloudos job list` command.
- Minor changes in `stdout` of the other commands to improve
readability.
- Adds a small docstring to each command.
### 0.0.2 - 2021-09-07
- Refactors `runjob` and `jobstatus` commands. Now, the main
`cloudos` tool have the `job` subtool which in turn has its
`run` and `status` commands performing the previous
functionality. This way, now the tool can be used with:
`cloudos job run [OPTIONS]` and `cloudos job status [OPTIONS]`.
- Adding `--wait-completion` option to `cloudos job run` command,
to be able to wait until job completion or failure.
### 0.0.1 - 2021-08-18
Initial implementation of the `cloudos` python package:
- Implements `runjob` and `jobstatus` commands to send jobs and get
their status, respectively.
API endpoint change detected
Source PR: mock
Changed endpoints
[ { "method": "GET", "path": "/api/v1/projects/{id}/members", "change_type": "added", "auth": [ "userApiToken" ], "summary": "Returns members of a project" } ]Change type guide
added: create a new CLI command and register itmodified: update the existing command, parameters and/or output handlingremoved: deprecate and delete the existing CLI command gracefullyrefactored: update internals only - keep the CLI interface identicalWhat to implement
cloudos_cli/_version.py(currently:__version__ = '2.91.0')CHANGELOG.mdmatching the existing formatcloudos_cli/<module>/cloudos_cli/clos.pyor module files likecloudos_cli/jobs/job.pycloudos_cli/commands/directory - do not create onetests/using pytest + responses + mocksupported-endpoints.jsonto reflect the changeRelevant existing manifest entries
[ { "id": "projects-create", "method": "POST", "path": "/api/v1/projects", "query_params": [ "teamId" ], "cli_command": "cloudos project create", "source_file": "cloudos_cli/clos.py", "added_in_version": "2.91.0", "notes": null } ]Recent changelog (match this format exactly)