Skip to content

Commit eeea7a7

Browse files
committed
adding "include" parameter and error message information
Signed-off-by: Neal Ensor <[email protected]>
1 parent 8c00186 commit eeea7a7

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

swagger.yaml

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -607,6 +607,14 @@ paths:
607607
with DataCite, and have a live DOI value
608608
schema:
609609
type: boolean
610+
- in: query
611+
name: include
612+
description: List of fields to include in results, comma-delimited
613+
schema:
614+
type: string
615+
example:
616+
- id,doi,title
617+
- status,doi_message,date_record_updated
610618
- in: query
611619
name: sort
612620
description: Define a sort-by value for search results
@@ -656,8 +664,25 @@ paths:
656664
type: array
657665
items:
658666
$ref: '#/components/schemas/recordType'
659-
default:
660-
description: Default error sample response
667+
'400':
668+
description: Bad request, unable to interpret parameters or values in search
669+
content:
670+
application/json:
671+
schema:
672+
type: object
673+
properties:
674+
status:
675+
description: HTTP status code
676+
type: integer
677+
default: 400
678+
errors:
679+
description: List of error messages specific to this issue
680+
type: array
681+
items:
682+
type: string
683+
example:
684+
- Unable to parse date value
685+
- Start not numeric
661686
servers:
662687
- url: 'https://www.osti.gov/iad2'
663688
variables: {}

0 commit comments

Comments
 (0)