API definition transferred by SwaggerHub #1
Conversation
| type: integer | ||
| maximum_duration: | ||
| type: integer | ||
| duration_type: |
There was a problem hiding this comment.
I am not opposed to this, but the last conversation we had I believe SEARCH was wanting us to just standardize and report everything back in our response in days. I am fine to keep it and add support (or not) if we find a need for it.
There was a problem hiding this comment.
The duration_type could also be defined as optional and we could just say that if it's missing, the specified durations could be assumed to be in days.
| raw_text: | ||
| type: string | ||
| description: Raw (unstructured) text string from the source system | ||
| confidence: |
There was a problem hiding this comment.
Since we haven't picked any specific algorithms or services yet, it's impossible to know what the confidence output would look like. But 0-100 is pretty granular for downstream use and we might want to have "buckets" of confidence like low, medium, and high. We could store something more granular on our side so that it can be translated back and forth but I feel like that granularity might not be useful for SEARCH.
There was a problem hiding this comment.
A fair point. Maybe confidence could be an object with score (0-100) and level (low, medium, high) properties, and score could be optional.
output/index.yaml
Outdated
| description: "Sentencing date (month, day, and year)" | ||
| format: date | ||
| fine: | ||
| $ref: '#/components/schemas/SentenceTypeWithFines' |
There was a problem hiding this comment.
I like what you did to combine the duration and type together - however I am slightly concerned that unpacking these responses might be more difficult and it could be better to store the boolean part at the top level of the response. I am open to either though
There was a problem hiding this comment.
I think it would be easier to talk through this one in our meeting.
| $ref: '#/components/schemas/SentenceTypeWithDuration' | ||
| treatment: | ||
| $ref: '#/components/schemas/SentenceTypeWithDuration' | ||
| death: |
There was a problem hiding this comment.
what is death? death sentence? Not sure where this came from, but I think we may have lost life_sentence_indicator (not sure if that is what you meant or if this is a new type from CJARs - but this refers to whether the sentence is a life sentence).
There was a problem hiding this comment.
yeah. it was from CJARS. a death sentence type.
|
|
||
| # Use this file to prevent files from being overwritten by the generator. | ||
| # The patterns follow closely to .gitignore or .dockerignore. | ||
|
|
There was a problem hiding this comment.
Add this to .gitignore (probably entire output directory)
No description provided.