Skip to content

Commit 6c1730b

Browse files
authored
clean up documentation
Fix "include" description
1 parent eeea7a7 commit 6c1730b

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

swagger.yaml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -609,12 +609,11 @@ paths:
609609
type: boolean
610610
- in: query
611611
name: include
612-
description: List of fields to include in results, comma-delimited
612+
description: >-
613+
Optional list of fields to include in results (comma-delimited). If not
614+
provided, all fields will be returned in results
613615
schema:
614616
type: string
615-
example:
616-
- id,doi,title
617-
- status,doi_message,date_record_updated
618617
- in: query
619618
name: sort
620619
description: Define a sort-by value for search results
@@ -686,7 +685,7 @@ paths:
686685
servers:
687686
- url: 'https://www.osti.gov/iad2'
688687
variables: {}
689-
description: Interagency Data API Service production server
688+
description: Interagency Data API Service (production)
690689
- url: 'https://www.osti.gov/iad2test'
691690
variables: {}
692-
description: Interagency Data API Testing server
691+
description: Interagency Data API Service (testing)

0 commit comments

Comments
 (0)