Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code formating #142

Merged
merged 19 commits into from
Jan 15, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-22.04
strategy:
matrix:
java_version: [11, 17]
java_version: [ 11, 17 ]

steps:
# Setup Java & Python
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.idea
ids.server.iml
/target/
/.settings/
/.classpath
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

General installation instructions are at http://www.icatproject.org/installation/component

Specific installation instructions are at https://repo.icatproject.org/site/ids/server/${project.version}/installation.html
Specific installation instructions are
at https://repo.icatproject.org/site/ids/server/${project.version}/installation.html

All documentation on ids.server may be found at https://repo.icatproject.org/site/ids/server/${project.version}
5 changes: 3 additions & 2 deletions assemble/distribution.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<id>distro</id>
<formats>
<format>zip</format>
Expand Down
26 changes: 13 additions & 13 deletions miredot.htmlintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@ <h1>IDS Restful API</h1>

<h2>authorization</h2>
<p>
Most operations require a sessionId from making a login call to
ICAT. The sessionId is then used to check that the operation on the
data is permitted by following the general rule that if you are allowed
that access to the metadata then you are allowed the same access to the
data.
Most operations require a sessionId from making a login call to
ICAT. The sessionId is then used to check that the operation on the
data is permitted by following the general rule that if you are allowed
that access to the metadata then you are allowed the same access to the
data.
</p>

<h2>Error handling</h2>
<p>
In the case of an error the returned json will be of the form:
{"code":"NotFoundException", "message":"One of the data files requested
has been deleted"}. Clients should always check the status code and if
status/100 is not 2 then an error has occurred.
In the case of an error the returned json will be of the form:
{"code":"NotFoundException", "message":"One of the data files requested
RKrahl marked this conversation as resolved.
Show resolved Hide resolved
has been deleted"}. Clients should always check the status code and if
status/100 is not 2 then an error has occurred.
</p>

<h2>Testing</h2>
<p>
The @GET calls can be tried on a web browser and curl can be used to
make any of the calls. For example a url of the form:
<kbd>https://example.com/ids/version</kbd> will return some text such
as <samp>{"version":"2.0.0"}</samp>
The @GET calls can be tried on a web browser and curl can be used to
make any of the calls. For example a url of the form:
<kbd>https://example.com/ids/version</kbd> will return some text such
as <samp>{"version":"2.0.0"}</samp>
RKrahl marked this conversation as resolved.
Show resolved Hide resolved
</p>
Loading