Commit graph

51 commits

Author SHA1 Message Date
Sonja Happ
d2c94d1886 - models: remove imageHeight and imageWidth from File model (is customProperty of image widget)
- test data: add test data in test mode via API instead of GORM
- fix typos and update API documentation
2020-03-13 17:16:12 +01:00
Sonja Happ
ef1dede70c renaming: simulation model = component configuration 2020-03-06 15:14:29 +01:00
Sonja Happ
5d63fc3e26 update configs 2020-03-04 16:54:50 +01:00
Sonja Happ
11a0c53b85 rename simulator to infrastructure component 2020-03-04 16:34:24 +01:00
Sonja Happ
13f2ae7de3 simulationModel: rename response field from model(s) to simulationModel(s) 2019-11-26 14:22:26 +01:00
Sonja Happ
92f22035c6 add GPL 3.0 license statement in all (not auto-generated) code files 2019-11-20 11:08:33 +01:00
Sonja Happ
de4ac7b9b5 Clean up pipeline:
- CI: remove prepare stage for redoc image from pipeline
- remove obsolete API doc related files
2019-11-19 15:51:49 +01:00
Sonja Happ
9deed119fd fixes for healthz and metrics endpoints
- no authentication
- swagger documentation update
2019-11-14 12:34:20 +01:00
0119a2947e swaggo: update generated docs 2019-11-13 20:52:58 +01:00
Sonja Happ
32bff963d2 improves swaggo documentation
- remove blank lines
- add and improve links
2019-11-13 15:03:31 +01:00
Sonja Happ
a8a43f8512 Improvements for swagger API documentation
- Adds Authorization token as required header param to all endpoints (except authenticate itself)
- Documents correct data format for request bodies (relevant for updating and adding elements)
- No functional changes applied
2019-11-13 14:48:08 +01:00
2311d643c6 fix repo path 2019-11-09 11:40:56 +01:00
Sonja Happ
ebf390e9cc update version of swag tool, use swag again in CI, works on #22 2019-09-16 09:17:31 +02:00
Sonja Happ
f3a7ed0e61 **Major revision of repository structure**
- rename common package to database
- move all code not related to database to new helper package
- add more test in database package to improve code coverage
- add a new (own) package for AMQP client
2019-09-10 16:28:57 +02:00
Sonja Happ
f0baf38398 add API doc files auto-generated by swag 2019-09-10 14:38:00 +02:00
Sonja Happ
f339c0d135 - revise testing of file endpoints
- revise documentation for swaggo
- clean up testdata
- delete serializers and responses files
- revise file endpoint implementations
2019-09-06 17:04:40 +02:00
Sonja Happ
7544c863de - revise testing of signal endpoints
- revise documentation for swaggo
- clean up testdata, serializers and responses
- add validators for signal endpoints
- revise signal endpoint implementations
2019-09-06 16:01:59 +02:00
Sonja Happ
e3651e34f0 - revise testing of widget enpoints
- add validators for widgets
- revise implementation of widget endpoints
- clean up testdata, serializers and response
- improve documentation for swaggo
2019-09-06 15:10:25 +02:00
Sonja Happ
dab027eef6 - revise testing of dashboard enpoints
- clean up testdata, serializers and responses
- add validators for dashboards
- revise documentation of dashboard endpoints for swaggo
- revise endpoint implementations
2019-09-06 14:07:36 +02:00
Sonja Happ
a55d039ee7 - revise testing of simulators
- add validators for simulators
- clean up testdata, serializers and responses
- update documentation for swaggo
2019-09-05 12:23:44 +02:00
Sonja Happ
6221f7d851 user testing: fix responses of successful queries 2019-09-03 16:59:30 +02:00
Sonja Happ
bddbfc028d fix swaggo documentation of user endpoints 2019-09-03 12:03:47 +02:00
Sonja Happ
c33438b395 renaming visualization to dashboard 2019-07-18 13:11:05 +02:00
Sonja Happ
ea974ba32b generate and deploy api docs based on swag tool 2019-06-06 09:57:40 +02:00
Sonja Happ
f6ea39af12 Merge branch 'master' into authentication
# Conflicts:
#	go.mod
#	go.sum
#	routes/user/userEndpoints.go
#	routes/user/userSerializer.go
#	start.go
2019-05-28 10:40:53 +02:00
Sonja Happ
b89a68296f Experimenting with testing and auto generating API specs based on code 2019-05-23 14:36:42 +02:00
Sonja Happ
0b1d8657b9 add (REMOVED) keyword to all endpoints that are replaced or removed in the new backend 2019-05-21 17:04:55 +02:00
Sonja Happ
8f2e039ff0 removed signal/sample naming chaos 2019-05-21 16:51:34 +02:00
Sonja Happ
a78bf892f5 Renaming:
- SimulationModel to Model
- Signal to Sample
2019-05-21 09:14:44 +02:00
Sonja Happ
e7b15f6e5d some API doc updates from today's meeting 2019-05-20 11:56:53 +02:00
Sonja Happ
5a6ec9108c minor fixes in API doc 2019-05-16 14:14:31 +02:00
Sonja Happ
9331e07de9 Revision of API documentation:
- adding response codes to each endpoint
- removing recursion from component models
- changing order of tags
2019-05-16 13:15:02 +02:00
Sonja Happ
e03f076161 - rename "cimfile" to "file"
- fix API documentation
- move /uploads POST endpoint to /files POST
- add /files/FileID PUT endpoint for updating files
- mark removed and new endpoints in API doc
2019-05-16 09:27:44 +02:00
Sonja Happ
6894dd961f fix api documentation for new CIM file endpoints 2019-05-15 16:10:00 +02:00
Richard Marston
3f3a1346b7 New URL as discussed with stvogel 2019-05-14 13:41:53 +02:00
Richard Marston
83c148abeb Correct repeat key declaration error 2019-05-14 10:02:27 +02:00
Richard Marston
cd96e20962 add URL for querying and editing models associated with a simulation 2019-05-13 14:47:21 +02:00
3d6fbf36e6 API doc: remove rendered HTML from repo 2019-04-16 22:36:27 +02:00
dbf98f56d6 API doc: enable CI 2019-04-16 22:34:46 +02:00
Sonja Happ
367ead0fb8 API doc: use redoc-cli instead of swagger codegen; add html documentation 2019-04-16 10:19:46 +02:00
Sonja Happ
fea4d45e71 API doc: completed users and visualizations 2019-04-15 17:05:36 +02:00
Sonja Happ
4bae7ffcdb API doc: completed uploads 2019-04-15 14:53:07 +02:00
Sonja Happ
9ce4c421a2 API doc: completed simulators 2019-04-15 14:38:14 +02:00
Sonja Happ
95e1bccf7c API doc: completed projects and simulationmodels 2019-04-15 14:24:31 +02:00
Sonja Happ
d7cfb8c6b6 API doc: completed counts and files 2019-04-15 13:35:56 +02:00
Sonja Happ
ef3c1bad7b API doc: completed simulations endpoints 2019-04-15 13:16:17 +02:00
Sonja Happ
651b860b55 API doc: add all datastructs 2019-04-15 12:32:53 +02:00
Sonja Happ
49c9dc26a7 API doc: started documentation using OPENAPI 3.0.1 2019-04-15 12:04:56 +02:00
Sonja Happ
85473f5786 experimenting with swagger, Makefile currently not working, WIP 2019-04-11 13:20:32 +02:00
Sonja Happ
3bc6c8f11f add yaml file and Makefile for swagger-based API documentation 2019-04-10 15:49:55 +02:00