Skip to content

Commit

Permalink
Adding instructions to edit the servers entry in the Swagger UI
Browse files Browse the repository at this point in the history
  • Loading branch information
lcahlander committed Dec 1, 2021
1 parent 2c55b77 commit 5c118d6
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 6 deletions.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<groupId>org.xqdoc</groupId>
<artifactId>exist-xqdoc</artifactId>
<version>0.6.2</version>
<version>0.6.3</version>

<name>xqDoc Function Documentation</name>
<description>Application and library to generate and display XQuery function documentation for eXist-db</description>
Expand Down
21 changes: 17 additions & 4 deletions src/main/js/frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/main/js/frontend/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "xqDoc",
"version": "0.6.2",
"version": "0.6.3",
"private": true,
"homepage": ".",
"proxy": "http://localhost:8080/",
Expand Down
5 changes: 5 additions & 0 deletions src/main/js/frontend/src/Home.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export default class Home extends Component {
<div>The information for this application is generated out of the xqDoc
files that are generated from the XQuery code and the Rest APIs
are generated from the RestXQ annotations within the code.</div>
<h2>Regeneration</h2>
<div>If new code has been added , then there are two ways to get
the xqDoc files up to date.</div>
<ol>
Expand All @@ -24,6 +25,10 @@ export default class Home extends Component {
<XMLViewer xml={xml} />
</li>
</ol>
<h2>RestAPIs</h2>
<div>In order to set the Servers dropdown value, in eXide open
&nbsp;<b>/db/apps/xqdoc/data/openapi.json</b> and edit the
&nbsp;<b>servers</b> entry and save it.</div>
</>
)
}
Expand Down

0 comments on commit 5c118d6

Please sign in to comment.