feat: document jobconfig file #56
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update .gitignore
- Remove trailing spaces - Wrap long lines - A couple minor markdown syntax fixes
4 tasks
Documents scicat-backend-next#1463
- Document ValidateAction changes (#1473) - Convert examples to YAML (#1463)
4 tasks
despadam
reviewed
Jan 8, 2025
Comment on lines
297
to
322
| - RABBITMQ\_ENABLED: | ||
| Flag to enable/disable RabbitMQ consumer. | ||
| accepted values: "yes", "no" | ||
| _deprecated_. Will be removed in future releases. | ||
| _default_: no | ||
| _format_: string | ||
|
|
||
| - RABBITMQ\_HOSTNAME: | ||
| The hostname of the RabbitMQ message broker. Only required if RabbitMQ is enabled. | ||
| _deprecated_. Will be removed in future releases. | ||
| _default_: no default | ||
| _default_: string | ||
|
|
||
| - RABBITMQ\_USERNAME: | ||
| The username used to authenticate to the RabbitMQ message broker. Only required if | ||
| RabbitMQ is enabled. | ||
| _deprecated_. Will be removed in future releases. | ||
| _default_: no default | ||
| _format_: string | ||
|
|
||
| - RABBITMQ\_PASSWORD: | ||
| The password used to authenticate to the RabbitMQ message broker. Only required if | ||
| RabbitMQ is enabled. | ||
| _deprecated_. Will be removed in future releases. | ||
| _default_: no default | ||
| _format_: string |
There was a problem hiding this comment.
Why are these marked as deprecated?
despadam
reviewed
Jan 8, 2025
| @@ -280,7 +280,7 @@ before running the backend. A basic rabbitMQ set up in the component-config.loca | |||
|
|
|||
| ``` | |||
| The exchange and the binding key must be named `jobs.write` and `jobqueue` respectively, the queue name can take any value. | |||
| The backend expects and exchange called `jobs.write` to publish jobs messages to bound with that key. | |||
| The backend expects an exchange called `jobs.write` to publish jobs messages to bound with that key. | |||
There was a problem hiding this comment.
Is the Connecting Scicat to RabbitMQ section still needed?
refactored job tests update
sbliven
added a commit
to SciCatProject/scicat-backend-next
that referenced
this pull request
Feb 26, 2025
## Description
Allows jobs to validate properties of the dataset.
## Motivation
The `validate` action currently allows operators to enforce attributes
of the DTO.
However, many jobs depend on `jobParams.datasetLists` to link a job to
certain datasets. This allows validation of properties on datasets
associated with the dataset.
The motivating example would be checking datasetLifecycle properties for
certain jobs. These are currently hard-coded for special job types. This
would allow them to be applied to custom job types as well.
```
configVersion: v1.0
jobs:
- jobType: custom_archive
create:
auth: "#datasetAccess"
actions:
- actionType: validate
datasets:
datasetlifecycle.archivable:
const: true
```
## Changes:
* Add `datasets` property to validate actions (only in `create`
operations) to validate linked dataset properties
## Tests included
(WIP pending tests and documentation)
- [x] Included for each change/fix?
- [x] Passing? <!-- Merge will not be approved unless tests pass -->
## Documentation
- [x] swagger documentation updated (required for API changes)
- [x] official documentation updated
### official documentation info
Docs are included in
SciCatProject/documentation#56
4 tasks
|
For those wanting to read the rendered doc pages, I suggest starting with job configuration, authorization and testing |
4 tasks
emigun
reviewed
Mar 5, 2025
|
|
||
| #### Validate | ||
|
|
||
| The `validate` action is used to check validate requests to the job endpoints. It is |
There was a problem hiding this comment.
Is this sentence correct? Should it be check and validate or just to validate requests perhaps?
4 tasks
Add test for anonymous user
Jobs read permission testing suites added
missed change for patch Co-authored-by: Despina Adamopoulou <16343312+despadam@users.noreply.github.com>
Changes from release-jobs and backwards compatibility
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for jobconfig.json file