Skip to content

feat: improved logging, scaling and documentation #23

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.

Sign up for GitHub

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

Merged
merged 13 commits into from
May 22, 2025
+1,343 −239
Merged

feat: improved logging, scaling and documentation #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2e5badf
Improved scaling behaviour, and passing through scaling params
PeterBaker0 May 19, 2025
5072054
Improving validation
PeterBaker0 May 19, 2025
86c071f
Logging docs, improvements based on using task definitions rather tha…
PeterBaker0 May 19, 2025
f520c4d
Fixing undefined issues
PeterBaker0 May 19, 2025
8f02c1b
Downgrade log level
PeterBaker0 May 19, 2025
7bffdbe
Downgrading log level
PeterBaker0 May 19, 2025
7523968
FOrmatting
PeterBaker0 May 19, 2025
3c684bb
Tuning params
PeterBaker0 May 19, 2025
b612733
Adding job tests and new payload options
PeterBaker0 May 21, 2025
6da77ce
Reverting
PeterBaker0 May 21, 2025
a8f8b48
Merge pull request #24 from open-AIMS/feat/adding-missing-criteria
PeterBaker0 May 21, 2025
5bde719
Fixes from review
PeterBaker0 May 22, 2025
7b6843f
Formatting
PeterBaker0 May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 70 additions & 10 deletions api-test/jobs.http
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,50 @@ Authorization: Bearer {{authToken}}
{
"type": "TEST",
"inputPayload": {
"id" : 1
"id" : 1111111
}
}

### Create a new suitability assessment job
### Create a new regional assessment job (with full params)
# @name createRegionalAssessmentJob
POST {{baseUrl}}/jobs
Content-Type: {{contentType}}
Authorization: Bearer {{authToken}}

{
"type": "REGIONAL_ASSESSMENT",
"inputPayload": {
"region": "Mackay-Capricorn",
"reef_type": "slopes",
"depth_min": -10.1,
"depth_max": -2.1,
"slope_min": 0.1,
"slope_max": 30.0,
"rugosity_min": 0.0,
"rugosity_max": 6.0,
"waves_period_min": 1.94303,
"waves_period_max": 9.32689,
"waves_height_min": 0.237052,
"waves_height_max": 2.53194,
"threshold": 95
}
}

### Create a new regional assessment job (with minimal params)
# @name createRegionalAssessmentJob
POST {{baseUrl}}/jobs
Content-Type: {{contentType}}
Authorization: Bearer {{authToken}}

{
"type": "REGIONAL_ASSESSMENT",
"inputPayload": {
"region": "Mackay-Capricorn",
"reef_type": "slopes"
}
}

### Create a new suitability assessment job (with full params)
# @name createSuitabilityJob
POST {{baseUrl}}/jobs
Content-Type: {{contentType}}
Expand All @@ -63,20 +102,41 @@ Authorization: Bearer {{authToken}}
{
"type": "SUITABILITY_ASSESSMENT",
"inputPayload": {
"region": "Cairns-Cooktown",
"region": "Mackay-Capricorn",
"reef_type": "slopes",
"depth_min": -7.0,
"depth_max": -3.9,
"slope_min": 0.2,
"slope_max": 40.0,
"depth_min": -10.1,
"depth_max": -2.1,
"slope_min": 0.1,
"slope_max": 30.0,
"rugosity_min": 0.0,
"rugosity_max": 6.0,
"x_dist" : 450,
"y_dist" : 20,
"waves_period_min": 1.94303,
"waves_period_max": 9.32689,
"waves_height_min": 0.237052,
"waves_height_max": 2.53194,
"x_dist": 451,
"y_dist": 27,
"threshold": 95
}
}

### Create a new suitability assessment job (with minimal params)
# @name createSuitabilityJob
POST {{baseUrl}}/jobs
Content-Type: {{contentType}}
Authorization: Bearer {{authToken}}

{
"type": "SUITABILITY_ASSESSMENT",
"inputPayload": {
"region": "Mackay-Capricorn",
"reef_type": "slopes",
"x_dist": 451,
"y_dist": 27
}
}


### Store the job IDs for further operations
@jobId = {{createJob.response.body.jobId}}
@jobId = {{createSuitabilityJob.response.body.jobId}}
Expand Down Expand Up @@ -241,4 +301,4 @@ Authorization: Bearer {{authToken}}

### Try download (should fail as job is not complete)
GET {{baseUrl}}/jobs/{{jobId}}/download
Authorization: Bearer {{authToken}}
Authorization: Bearer {{authToken}}
Loading