Skip to content
This repository was archived by the owner on Oct 6, 2023. It is now read-only.

Commit bdbaeaa

Browse files
nensornensor
committed
Merge branch 'master' of https://github.com/doecode/server 
2 parents b36861c + 3117722 commit bdbaeaa

File tree

2 files changed

+73
-68
lines changed

2 files changed

+73
-68
lines changed

‎src/main/java/gov/osti/services/Search.md‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,21 +65,6 @@ Content-Type: application/json
6565
Send a search request, defining parameters and search terms in the POST request
6666
body. The input JSON may contain any of the following:
6767

68-
| Name | Description |
69-
| --- | --- |
70-
| all_fields | Search for value in all the available search fields |
71-
| software_title | Search for value in the software title |
72-
| developers_contributors | Search for the value in developer or contributor names |
73-
| identifiers | Search within identifying numbers |
74-
| date_earliest | Starting date range for release date |
75-
| date_latest | Ending date range for release date |
76-
| accessibility | An array of accessibility types; one or more of "OS", "ON", or "CS" |
77-
| licenses | An array of matching license values, such as the ones at the following <a href='/doecodeapi/services/types#doecode-types-api-valid-types-information-licenses'>endpoint</a>. |
78-
| orcid | Search developer or contributor ORCID values |
79-
| sort | Specify a sorting field, e.g., "softwareTitle" or "releaseDate" (relevance is the default) |
80-
| rows | Desired number of rows to return (default 20) |
81-
| start | Offset row number to start for pagination (0 based) |
82-
8368
> Request:
8469
```html
8570
POST /doecodeapi/services/search
@@ -120,3 +105,20 @@ Content-Type: application/json
120105
]
121106
}
122107
```
108+
109+
| Name | Description |
110+
| --- | --- |
111+
| all_fields | Search for value in all the available search fields |
112+
| software_title | Search for value in the software title |
113+
| developers_contributors | Search for the value in developer or contributor names |
114+
| identifiers | Search within identifying numbers |
115+
| date_earliest | Starting date range for release date |
116+
| date_latest | Ending date range for release date |
117+
| accessibility | An array of accessibility types; one or more of "OS", "ON", or "CS" |
118+
| licenses | An array of matching license values, such as the ones at the following <a href='/doecodeapi/services/types#doecode-types-api-valid-types-information-licenses'>endpoint</a>. |
119+
| orcid | Search developer or contributor ORCID values |
120+
| sort | Specify a sorting field, e.g., "softwareTitle" or "releaseDate" (relevance is the default) |
121+
| rows | Desired number of rows to return (default 20) |
122+
| start | Offset row number to start for pagination (0 based) |
123+
124+

‎src/main/webapp/WEB-INF/jsp/search.jsp‎

Lines changed: 56 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,57 +7,60 @@
77
<%@page contentType="text/html" pageEncoding="UTF-8"%>
88
<!DOCTYPE html>
99
<html>
10-
<head>
11-
<meta charset='utf-8'>
12-
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
13-
<meta name="viewport" content="width=device-width">
14-
15-
<title>DOECode Search API Documentation</title>
16-
17-
<!-- Flatdoc -->
18-
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
19-
<script src='${pageContext.request.contextPath}/js/legacy.js'></script>
20-
<script src='${pageContext.request.contextPath}/js/flatdoc.js'></script>
21-
22-
<!-- Flatdoc theme -->
23-
<link href="${pageContext.request.contextPath}/css/flatdoc-theme.css" rel="stylesheet">
24-
<link href="${pageContext.request.contextPath}/css/doecodeapi.css" rel="stylesheet">
25-
<script src="${pageContext.request.contextPath}/js/flatdoc-theme.js"></script>
26-
27-
<!-- Meta -->
28-
<meta content="DOECode Services API" property="og:title">
29-
<meta content="Back-end services for DOECode application." name="description">
30-
31-
<!-- Initializer -->
32-
<script>
33-
Flatdoc.run({
34-
fetcher: Flatdoc.github('doecode/server', 'src/main/java/gov/osti/services/Search.md' )
35-
});
36-
</script>
37-
</head>
38-
<body role='flatdoc'>
39-
40-
<div class='header'>
41-
<div class='left'>
42-
<h1>DOECode API</h1>
43-
<ul>
44-
<li><a href='/doecodeapi/services'>API Services Documentation</a></li>
45-
<li><a href='https://github.com/doecode/server'>View on GitHub</a></li>
46-
<li><a href='https://github.com/doecode/server/issues'>Issues</a></li>
47-
</ul>
48-
</div>
49-
<div class='right'>
50-
<!-- GitHub buttons: see http://ghbtns.com -->
51-
<iframe src="https://ghbtns.com/github-btn.html?user=doecode&repo=server&type=watch&count=true&v=2" frameborder="0" scrolling="0" width="170" height="20"></iframe>
52-
</div>
53-
</div>
54-
55-
<div class='content-root'>
56-
<div class='menubar'>
57-
<div class='menu section' role='flatdoc-menu'></div>
58-
</div>
59-
<div role='flatdoc-content' class='content'></div>
60-
</div>
61-
62-
</body>
10+
<head>
11+
<meta charset='utf-8'>
12+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
13+
<meta name="viewport" content="width=device-width">
14+
15+
<title>DOECode Search API Documentation</title>
16+
17+
<!-- Flatdoc -->
18+
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
19+
<script src='${pageContext.request.contextPath}/js/legacy.js'></script>
20+
<script src='${pageContext.request.contextPath}/js/flatdoc.js'></script>
21+
22+
<!-- Flatdoc theme -->
23+
<link href="${pageContext.request.contextPath}/css/flatdoc-theme.css" rel="stylesheet">
24+
<link href="${pageContext.request.contextPath}/css/doecodeapi.css" rel="stylesheet">
25+
<script src="${pageContext.request.contextPath}/js/flatdoc-theme.js"></script>
26+
27+
<!-- Meta -->
28+
<meta content="DOECode Services API" property="og:title">
29+
<meta content="Back-end services for DOECode application." name="description">
30+
31+
<!-- Initializer -->
32+
<script>
33+
//Flatdoc.run({
34+
// fetcher: Flatdoc.file('../Search.md')
35+
//});
36+
Flatdoc.run({
37+
fetcher: Flatdoc.github('doecode/server', 'src/main/java/gov/osti/services/Search.md')
38+
});
39+
</script>
40+
</head>
41+
<body role='flatdoc'>
42+
43+
<div class='header'>
44+
<div class='left'>
45+
<h1>DOECode API</h1>
46+
<ul>
47+
<li><a href='/doecodeapi/services'>API Services Documentation</a></li>
48+
<li><a href='https://github.com/doecode/server'>View on GitHub</a></li>
49+
<li><a href='https://github.com/doecode/server/issues'>Issues</a></li>
50+
</ul>
51+
</div>
52+
<div class='right'>
53+
<!-- GitHub buttons: see http://ghbtns.com -->
54+
<iframe src="https://ghbtns.com/github-btn.html?user=doecode&repo=server&type=watch&count=true&v=2" frameborder="0" scrolling="0" width="170" height="20"></iframe>
55+
</div>
56+
</div>
57+
58+
<div class='content-root'>
59+
<div class='menubar'>
60+
<div class='menu section' role='flatdoc-menu'></div>
61+
</div>
62+
<div role='flatdoc-content' class='content'></div>
63+
</div>
64+
65+
</body>
6366
</html>

0 commit comments

Comments
 (0)