Skip to content

Commit 2ede8b4

Browse files
dtheilerdtheiler
committed
release preps
1 parent 48877e1 commit 2ede8b4

File tree

19 files changed

+967
-3826
lines changed

19 files changed

+967
-3826
lines changed

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ The source-code can be directly checked-out through this repository. It contains
2020
* src: `SSS/ss-adapter/ss-adapter-rest-v1/src/main/webapp/api-docs/` and `SSS/ss-adapter/ss-adapter-rest-v2/src/main/webapp/api-docs/`
2121
* Swagger-UI-styled documentation from Swagger's JSON files
2222
* for apiVersion `v1` adapt `swagger-maven-plugin` in `SSS/ss-adapter/ss-adapter-rest-v1/pom.xml`
23-
* property `basePath` to `http://{your-host}:{your-port}/ss-adapter-rest-v1/SSAdapterRest`
24-
* property `swaggerUIDocBasePath` to `http://{your-host}:{your-port}/ss-adapter-rest-v1/api-docs`
23+
* property `basePath` to `http://{your-host}:{your-port}/ss-adapter-rest/SSAdapterRest`
24+
* property `swaggerUIDocBasePath` to `http://{your-host}:{your-port}/ss-adapter-rest/api-docs`
2525
* for apiVersion `v2` adapt `swagger-maven-plugin` in `SSS/ss-adapter/ss-adapter-rest-v2/pom.xml`
2626
* property `basePath` to `http://{your-host}:{your-port}/ss-adapter-rest-v2`
2727
* property `swaggerUIDocBasePath` to `http://{your-host}:{your-port}/ss-adapter-rest-v2/api-docs`
2828
* build and deploy web projects `SSS/ss-adapter/ss-adapter-rest-v1` and `SSS/ss-adapter/ss-adapter-rest-v2`
29-
* in web projects `.../src/main/webapp/swagger/index.html` adapt property `url` of object `SwaggerUi` to `http://{your-host}:{your-port}/ss-adapter-rest-v1/api-docs` and `http://{your-host}:{your-port}/ss-adapter-rest-v2/api-docs`respectively
29+
* in web projects `.../src/main/webapp/swagger/index.html` adapt property `url` of object `SwaggerUi` to `http://{your-host}:{your-port}/ss-adapter-rest/api-docs` and `http://{your-host}:{your-port}/ss-adapter-rest-v2/api-docs`respectively
3030

3131
## SSS for deployment
3232
* follow instructions for Java 8, Apache Tomcat 7, Apache Solr 4.9 and MySQL 5.6 in chapters below
@@ -122,7 +122,7 @@ The source-code can be directly checked-out through this repository. It contains
122122
* link Javascript projects `JSUtilities`, `SSClientInterfaceGlobals` and `SSSClientInterfaceREST` in your application to have access to SSS server-side operations via its REST interface
123123

124124
## SSS plain REST API V1 access
125-
* access the REST APIs via POST requests to `http://{your-sss-host}:{your-port}/ss-adapter-rest-v1/{API}/{yourOp}/`
125+
* access the REST APIs via POST requests to `http://{your-sss-host}:{your-port}/ss-adapter-rest/{API}/{yourOp}/`
126126
* `your-sss-host` and `your-port` represents the host and port running the REST APIs
127127
* `API` stands for the name of the REST API to be targeted:
128128
* `SSAdapterRest` for all REST operations except for file handling

‎ss-adapter/ss-adapter-rest-v1/pom.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444

4545
<apiSource>
4646
<apiVersion>v1</apiVersion>
47-
<basePath>http://localhost:8080/ss-adapter-rest-v1/SSAdapterRest</basePath>
47+
<basePath>http://localhost:8080/ss-adapter-rest/SSAdapterRest</basePath>
4848
<locations>at.kc.tugraz.ss.adapter.rest.v1</locations>
4949

5050
<apiInfo>
@@ -56,7 +56,7 @@
5656
<licenseUrl>${project.licenseURI}</licenseUrl>
5757
</apiInfo>
5858

59-
<swaggerUIDocBasePath>http://localhost:8080/ss-adapter-rest-v1/api-docs</swaggerUIDocBasePath>
59+
<swaggerUIDocBasePath>http://localhost:8080/ss-adapter-rest/api-docs</swaggerUIDocBasePath>
6060
<swaggerInternalFilter>com.wordnik.swagger.config.DefaultSpecFilter</swaggerInternalFilter>
6161
<outputPath>${basedir}/src/main/webapp/api-docs</outputPath>
6262
<swaggerDirectory>${basedir}/src/main/webapp/api-docs</swaggerDirectory>

‎ss-adapter/ss-adapter-rest-v1/src/main/java/at/kc/tugraz/ss/adapter/rest/v1/SSAdapterRest.java‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
*/
2121
package at.kc.tugraz.ss.adapter.rest.v1;
2222

23+
import at.kc.tugraz.socialserver.utils.SSLogU;
2324
import at.kc.tugraz.ss.adapter.rest.v1.par.SSSearchRESTAPIV1Par;
2425
import at.kc.tugraz.socialserver.utils.SSMethU;
2526
import at.kc.tugraz.socialserver.utils.SSStrU;
@@ -453,7 +454,11 @@ public String authCheckCred(
453454
par.key = SSRestMainV1.getBearer(headers);
454455
}catch(Exception error){}
455456

456-
return SSRestMainV1.handleStandardJSONRESTCall(par, par.op);
457+
String result = SSRestMainV1.handleStandardJSONRESTCall(par, par.op);
458+
459+
SSLogU.debug(result);
460+
461+
return result;
457462
}
458463

459464
@Deprecated

‎ss-adapter/ss-adapter-rest-v1/src/main/webapp/api-docs/SSAdapterRESTFile.json‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,76 @@
11
{
22
"apiVersion" : "v1",
33
"swaggerVersion" : "1.2",
4-
"basePath" : "http://localhost:8080/ss-adapter-rest-v1/SSAdapterRest",
4+
"basePath" : "http://localhost:8080/ss-adapter-rest/SSAdapterRest",
55
"resourcePath" : "/SSAdapterRESTFile",
66
"apis" : [ {
7-
"path" : "/fileUserFileWrites",
7+
"path" : "/fileCanWrite",
88
"operations" : [ {
99
"method" : "POST",
10-
"summary" : "retrieve files user currently could replace when uploading respective file again as he is writer",
10+
"summary" : "query whether given file can be downloaded with write access",
1111
"notes" : "",
12-
"type" : "SSFileGetEditingFilesRet",
13-
"nickname" : "fileUserFileWrites",
12+
"type" : "SSFileCanWriteRet",
13+
"nickname" : "fileCanWrite",
1414
"produces" : [ "application/json" ],
1515
"consumes" : [ "application/json" ],
1616
"parameters" : [ {
1717
"name" : "body",
1818
"required" : false,
19-
"type" : "SSFileUserFileWritesPar",
19+
"type" : "SSFileCanWritePar",
2020
"paramType" : "body",
2121
"allowMultiple" : false
2222
} ]
2323
} ]
2424
}, {
25-
"path" : "/fileSetReaderOrWriter",
25+
"path" : "/fileExtGet",
2626
"operations" : [ {
2727
"method" : "POST",
28-
"summary" : "set user being writer or reaader for given file",
28+
"summary" : "retrieve a file's extension",
2929
"notes" : "",
30-
"type" : "SSFileSetReaderOrWriterRet",
31-
"nickname" : "fileSetReaderOrWriter",
30+
"type" : "SSFileExtGetRet",
31+
"nickname" : "fileExtGet",
3232
"produces" : [ "application/json" ],
3333
"consumes" : [ "application/json" ],
3434
"parameters" : [ {
3535
"name" : "body",
3636
"required" : false,
37-
"type" : "SSFileSetReaderOrWriterPar",
37+
"type" : "SSFileExtGetPar",
3838
"paramType" : "body",
3939
"allowMultiple" : false
4040
} ]
4141
} ]
4242
}, {
43-
"path" : "/fileCanWrite",
43+
"path" : "/fileUserFileWrites",
4444
"operations" : [ {
4545
"method" : "POST",
46-
"summary" : "query whether given file can be downloaded with write access",
46+
"summary" : "retrieve files user currently could replace when uploading respective file again as he is writer",
4747
"notes" : "",
48-
"type" : "SSFileCanWriteRet",
49-
"nickname" : "fileCanWrite",
48+
"type" : "SSFileGetEditingFilesRet",
49+
"nickname" : "fileUserFileWrites",
5050
"produces" : [ "application/json" ],
5151
"consumes" : [ "application/json" ],
5252
"parameters" : [ {
5353
"name" : "body",
5454
"required" : false,
55-
"type" : "SSFileCanWritePar",
55+
"type" : "SSFileUserFileWritesPar",
5656
"paramType" : "body",
5757
"allowMultiple" : false
5858
} ]
5959
} ]
6060
}, {
61-
"path" : "/fileExtGet",
61+
"path" : "/fileSetReaderOrWriter",
6262
"operations" : [ {
6363
"method" : "POST",
64-
"summary" : "retrieve a file's extension",
64+
"summary" : "set user being writer or reaader for given file",
6565
"notes" : "",
66-
"type" : "SSFileExtGetRet",
67-
"nickname" : "fileExtGet",
66+
"type" : "SSFileSetReaderOrWriterRet",
67+
"nickname" : "fileSetReaderOrWriter",
6868
"produces" : [ "application/json" ],
6969
"consumes" : [ "application/json" ],
7070
"parameters" : [ {
7171
"name" : "body",
7272
"required" : false,
73-
"type" : "SSFileExtGetPar",
73+
"type" : "SSFileSetReaderOrWriterPar",
7474
"paramType" : "body",
7575
"allowMultiple" : false
7676
} ]
@@ -115,13 +115,13 @@
115115
"id" : "SSFileGetEditingFilesRet",
116116
"required" : [ "op" ],
117117
"properties" : {
118-
"labels" : {
118+
"files" : {
119119
"type" : "array",
120120
"items" : {
121121
"type" : "string"
122122
}
123123
},
124-
"files" : {
124+
"labels" : {
125125
"type" : "array",
126126
"items" : {
127127
"type" : "string"

‎ss-adapter/ss-adapter-rest-v1/src/main/webapp/api-docs/SSAdapterRESTFileDownload.json‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,28 @@
11
{
22
"apiVersion" : "v1",
33
"swaggerVersion" : "1.2",
4-
"basePath" : "http://localhost:8080/ss-adapter-rest-v1/SSAdapterRest",
4+
"basePath" : "http://localhost:8080/ss-adapter-rest/SSAdapterRest",
55
"resourcePath" : "/SSAdapterRESTFileDownload",
66
"apis" : [ {
7+
"path" : "/fileDownload",
8+
"operations" : [ {
9+
"method" : "POST",
10+
"summary" : "download a file via POST request",
11+
"notes" : "",
12+
"type" : "string",
13+
"format" : "byte",
14+
"nickname" : "fileDownload",
15+
"produces" : [ "application/octet-stream" ],
16+
"consumes" : [ "application/json" ],
17+
"parameters" : [ {
18+
"name" : "body",
19+
"required" : false,
20+
"type" : "SSFileDownloadPar",
21+
"paramType" : "body",
22+
"allowMultiple" : false
23+
} ]
24+
} ]
25+
}, {
726
"path" : "/fileDownloadGET",
827
"operations" : [ {
928
"method" : "GET",
@@ -34,25 +53,6 @@
3453
"allowMultiple" : false
3554
} ]
3655
} ]
37-
}, {
38-
"path" : "/fileDownload",
39-
"operations" : [ {
40-
"method" : "POST",
41-
"summary" : "download a file via POST request",
42-
"notes" : "",
43-
"type" : "string",
44-
"format" : "byte",
45-
"nickname" : "fileDownload",
46-
"produces" : [ "application/octet-stream" ],
47-
"consumes" : [ "application/json" ],
48-
"parameters" : [ {
49-
"name" : "body",
50-
"required" : false,
51-
"type" : "SSFileDownloadPar",
52-
"paramType" : "body",
53-
"allowMultiple" : false
54-
} ]
55-
} ]
5656
} ],
5757
"models" : {
5858
"SSFileDownloadPar" : {

‎ss-adapter/ss-adapter-rest-v1/src/main/webapp/api-docs/SSAdapterRESTFileReplace.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"apiVersion" : "v1",
33
"swaggerVersion" : "1.2",
4-
"basePath" : "http://localhost:8080/ss-adapter-rest-v1/SSAdapterRest",
4+
"basePath" : "http://localhost:8080/ss-adapter-rest/SSAdapterRest",
55
"resourcePath" : "/SSAdapterRESTFileReplace",
66
"apis" : [ {
77
"path" : "/fileReplace",

‎ss-adapter/ss-adapter-rest-v1/src/main/webapp/api-docs/SSAdapterRESTFileUpload.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"apiVersion" : "v1",
33
"swaggerVersion" : "1.2",
4-
"basePath" : "http://localhost:8080/ss-adapter-rest-v1/SSAdapterRest",
4+
"basePath" : "http://localhost:8080/ss-adapter-rest/SSAdapterRest",
55
"resourcePath" : "/SSAdapterRESTFileUpload",
66
"apis" : [ {
77
"path" : "/fileUpload",

0 commit comments

Comments
 (0)