Openapi #1
Openapi #1
Conversation
| get: | ||
| parameters: | ||
| - in: path | ||
| name: id |
There was a problem hiding this comment.
Should this be 'testid' rather than 'id' to match what you have above (ie /tests/{testid}/results/{id})
There was a problem hiding this comment.
since there is only a single parameter here it was self explanatory. But anything will work
| # type: array | ||
| # items: | ||
| # $ref: "#/components/schemas/Problem" | ||
| /tests/{testid}/results/{id}: |
There was a problem hiding this comment.
Would it make sense to explicitly name our 'id' everywhere or not? We are doing both here - using 'testid' but not using 'resultid'.
There was a problem hiding this comment.
"testid" is for the test and the other one is result id. It can work either way so it isn't too relevant. Ideally both should be "id" but then in the code we would have a mess.
Anyways whichever way we pick will produce the same result.
api/openapi.yaml
Outdated
| duration: | ||
| type: string | ||
| format: duration | ||
| nrOfSPans: |
There was a problem hiding this comment.
Picky comment... SPans should be Span. Really picky - should this be named nrOfSpans or numOfSpans - i have not seen nr as an abbreviation for number often.
There was a problem hiding this comment.
Good point I will adjust it.
Signed-off-by: Jasmin Gacic <[email protected]>
| duration: | ||
| type: string | ||
| format: duration | ||
| numOfSPans: |
There was a problem hiding this comment.
name seems wrong - numberOfSpans? spanCount?
| # description: object name | ||
| Test: | ||
| type: object | ||
| properties: |
There was a problem hiding this comment.
missing a read-only id property?
| Result: | ||
| type: object | ||
| properties: | ||
| successful: |
There was a problem hiding this comment.
missing a read-only id property?
| items: | ||
| $ref: "#/components/schemas/Assertion" | ||
| description: Definition of assertions that are going to be made | ||
| repeats: |
|
|
||
| components: | ||
| schemas: | ||
| # ObjectRef: |
| # description: object name | ||
| Test: | ||
| type: object | ||
| properties: |
There was a problem hiding this comment.
should have required sections for each object - so the client knows which values to rely on
#1) chore: update automated deployments on stage and add sync instructions
This PR...
Changes
Fixes
Checklist