chore: finalise 3.1.0

Informatievlaanderen · Jun 18, 2024 · f839814 · f839814
2 parents 1ac504a + ef0c3f5
commit f839814
Show file tree

Hide file tree

Showing 356 changed files with 6,773 additions and 5,951 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -21,8 +21,9 @@ COPY --from=app-stage ldes-server-infra-postgres/postgres-ingest-repository/targ
 COPY --from=app-stage ldes-server-infra-postgres/postgres-fetch-repository/target/postgres-fetch-repository-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-server-infra-postgres/postgres-retention-repository/target/postgres-retention-repository-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-server-infra-postgres/postgres-fragmentation-repository/target/postgres-fragmentation-repository-jar-with-dependencies.jar ./lib/
+COPY --from=app-stage ldes-server-infra-postgres/postgres-pagination-repository/target/postgres-pagination-repository-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-server-infra-postgres/postgres-admin-repository/target/postgres-admin-repository-jar-with-dependencies.jar ./lib/
-COPY --from=app-stage ldes-server-infra-migration/target/ldes-server-infra-migration-jar-with-dependencies.jar ./lib/
+COPY --from=app-stage ldes-server-infra-postgres/postgres-liquibase/target/postgres-liquibase-jar-with-dependencies.jar ./lib/
 
 COPY --from=app-stage ldes-server-port-ingest-rest/target/ldes-server-port-ingest-rest-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-server-port-ingest/target/ldes-server-port-ingest-jar-with-dependencies.jar ./lib/
@@ -32,8 +33,8 @@ COPY --from=app-stage ldes-server-admin/target/ldes-server-admin-jar-with-depend
 COPY --from=app-stage ldes-fragmentisers/ldes-fragmentisers-common/target/ldes-fragmentisers-common-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-fragmentisers/ldes-fragmentisers-geospatial/target/ldes-fragmentisers-geospatial-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-fragmentisers/ldes-fragmentisers-timebased-hierarchical/target/ldes-fragmentisers-timebased-hierarchical-jar-with-dependencies.jar ./lib/
-COPY --from=app-stage ldes-fragmentisers/ldes-fragmentisers-pagination/target/ldes-fragmentisers-pagination-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-fragmentisers/ldes-fragmentisers-reference/target/ldes-fragmentisers-reference-jar-with-dependencies.jar ./lib/
+COPY --from=app-stage ldes-server-pagination/target/ldes-server-pagination-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-server-retention/target/ldes-server-retention-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-server-compaction/target/ldes-server-compaction-jar-with-dependencies.jar ./lib/
 COPY --from=app-stage ldes-server-instrumentation/target/ldes-server-instrumentation-jar-with-dependencies.jar ./lib/

diff --git a/docker-compose/server.config.yml b/docker-compose/server.config.yml
@@ -27,9 +27,10 @@ spring:
     username: admin
     password: admin
   jpa:
-    hibernate:
-      ddl-auto: update
     database: postgresql
+  liquibase:
+    change-log: classpath:/db/changelog/master.xml
+
 #server:
 #  servlet:
 #    context-path: /ldes
diff --git a/docs/_configuration/event-stream.md b/docs/_configuration/event-stream.md
@@ -70,7 +70,7 @@ By defining a SHACL shape for the LDES, data producers can ensure that the membe
 they add to the LDES adhere to the required structure, while data consumers can use
 the shape to validate and reason about the data they receive.
 
-Defining a shape can be done through the `/admin/api/eventstreams/{collectionName}/shape` endpoint.
+Defining a shape can be done through the `/admin/api/v1/eventstreams/{collectionName}/shape` endpoint.
 
 For more info, visit the [Swagger API documentation.](./admin-api)
 

diff --git a/docs/_configuration/openapi.json b/docs/_configuration/openapi.json
@@ -3,7 +3,7 @@
   "info": {
     "title": "LDES Server Admin API",
     "description": "This API makes it possible to manage an LDES Server",
-    "version": "2.16.0-SNAPSHOT"
+    "version": "3.1.0"
   },
   "servers": [
     {
@@ -187,7 +187,8 @@
             "required": true,
             "schema": {
               "type": "string"
-            }
+            },
+            "example": "event-stream"
           }
         ],
         "responses": {
@@ -265,7 +266,8 @@
             "required": true,
             "schema": {
               "type": "string"
-            }
+            },
+            "example": "event-stream"
           }
         ],
         "requestBody": {
@@ -292,9 +294,6 @@
           "required": true
         },
         "responses": {
-          "400": {
-            "description": "The provided shacl shape is not valid"
-          },
           "200": {
             "description": "OK",
             "content": {
@@ -351,12 +350,140 @@
               }
             }
           },
+          "400": {
+            "description": "The provided shacl shape is not valid"
+          },
           "404": {
             "description": "No event stream with provided id could be found"
           }
         }
       }
     },
+    "/admin/api/v1/eventstreams/{collectionName}/eventsource": {
+      "put": {
+        "tags": [
+          "Event Streams"
+        ],
+        "summary": "Update the Event Source of an Event Stream",
+        "operationId": "updateEventSource",
+        "parameters": [
+          {
+            "name": "collectionName",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "example": "event-stream"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "text/turtle": {
+              "schema": {
+                "type": "string"
+              },
+              "example": "@prefix ldes: <https://w3id.org/ldes#> .\n@prefix dcterms: <http://purl.org/dc/terms/> .\n@prefix tree: <https://w3id.org/tree#>.\n\n<> a ldes:EventSource ;\n    ldes:retentionPolicy [\n        a ldes:DurationAgoPolicy ;\n        tree:value \"PT5S\"^^<http://www.w3.org/2001/XMLSchema#duration> ;\n      ] .\n"
+            },
+            "application/n-quads": {
+              "schema": {
+                "type": "string"
+              },
+              "example": "<http://njh.me/> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://w3id.org/ldes#EventSource> .\n<http://njh.me/> <https://w3id.org/ldes#retentionPolicy> _:genid1 .\n_:genid1 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://w3id.org/ldes#DurationAgoPolicy> .\n_:genid1 <https://w3id.org/tree#value> \"PT5S\"^^<http://www.w3.org/2001/XMLSchema#duration> .\n"
+            },
+            "application/ld+json": {
+              "example": [
+                {
+                  "@id": "_:b0",
+                  "@type": [
+                    "https://w3id.org/ldes#DurationAgoPolicy"
+                  ],
+                  "https://w3id.org/tree#value": [
+                    {
+                      "@value": "PT5S",
+                      "@type": "http://www.w3.org/2001/XMLSchema#duration"
+                    }
+                  ]
+                },
+                {
+                  "@id": "http://njh.me/",
+                  "@type": [
+                    "https://w3id.org/ldes#EventSource"
+                  ],
+                  "https://w3id.org/ldes#retentionPolicy": [
+                    {
+                      "@id": "_:b0"
+                    }
+                  ]
+                },
+                {
+                  "@id": "https://w3id.org/ldes#DurationAgoPolicy"
+                },
+                {
+                  "@id": "https://w3id.org/ldes#EventSource"
+                }
+              ]
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Event Source has been successfully updated",
+            "content": {
+              "text/turtle": {
+                "schema": {
+                  "type": "string"
+                },
+                "example": "@prefix ldes: <https://w3id.org/ldes#> .\n@prefix dcterms: <http://purl.org/dc/terms/> .\n@prefix tree: <https://w3id.org/tree#>.\n\n<> a ldes:EventSource ;\n    ldes:retentionPolicy [\n        a ldes:DurationAgoPolicy ;\n        tree:value \"PT5S\"^^<http://www.w3.org/2001/XMLSchema#duration> ;\n      ] .\n"
+              },
+              "application/n-quads": {
+                "schema": {
+                  "type": "string"
+                },
+                "example": "<http://njh.me/> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://w3id.org/ldes#EventSource> .\n<http://njh.me/> <https://w3id.org/ldes#retentionPolicy> _:genid1 .\n_:genid1 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://w3id.org/ldes#DurationAgoPolicy> .\n_:genid1 <https://w3id.org/tree#value> \"PT5S\"^^<http://www.w3.org/2001/XMLSchema#duration> .\n"
+              },
+              "application/ld+json": {
+                "example": [
+                  {
+                    "@id": "_:b0",
+                    "@type": [
+                      "https://w3id.org/ldes#DurationAgoPolicy"
+                    ],
+                    "https://w3id.org/tree#value": [
+                      {
+                        "@value": "PT5S",
+                        "@type": "http://www.w3.org/2001/XMLSchema#duration"
+                      }
+                    ]
+                  },
+                  {
+                    "@id": "http://njh.me/",
+                    "@type": [
+                      "https://w3id.org/ldes#EventSource"
+                    ],
+                    "https://w3id.org/ldes#retentionPolicy": [
+                      {
+                        "@id": "_:b0"
+                      }
+                    ]
+                  },
+                  {
+                    "@id": "https://w3id.org/ldes#DurationAgoPolicy"
+                  },
+                  {
+                    "@id": "https://w3id.org/ldes#EventSource"
+                  }
+                ]
+              }
+            }
+          },
+          "404": {
+            "description": "Event Stream with provided collection name could not be found"
+          }
+        }
+      }
+    },
     "/admin/api/v1/eventstreams/{collectionName}/dcat": {
       "put": {
         "tags": [
@@ -745,9 +872,6 @@
           "required": true
         },
         "responses": {
-          "400": {
-            "description": "The provided config is not valid"
-          },
           "201": {
             "description": "Created",
             "content": {
@@ -812,6 +936,9 @@
                 ]
               }
             }
+          },
+          "400": {
+            "description": "The provided config is not valid"
           }
         }
       }
@@ -917,6 +1044,34 @@
         }
       }
     },
+    "/admin/api/v1/eventstreams/{collectionName}/close": {
+      "post": {
+        "tags": [
+          "Event Streams"
+        ],
+        "summary": "Close an Event Stream",
+        "operationId": "closeEventStream",
+        "parameters": [
+          {
+            "name": "collectionName",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "example": "event-stream"
+          }
+        ],
+        "responses": {
+          "404": {
+            "description": "Event Stream with provided collection name could not be found"
+          },
+          "200": {
+            "description": "Event Stream is successfully closed and all related fragments are made immutable"
+          }
+        }
+      }
+    },
     "/admin/api/v1/dcat": {
       "get": {
         "tags": [
@@ -1262,6 +1417,9 @@
           "required": true
         },
         "responses": {
+          "400": {
+            "description": "Provided DCAT configuration is not valid"
+          },
           "201": {
             "description": "The generated UUID that is linked to the created DCAT",
             "content": {
@@ -1272,9 +1430,6 @@
                 "example": "e1c9443a-ab9f-407f-a65b-09d69f481966"
               }
             }
-          },
-          "400": {
-            "description": "Provided DCAT configuration is not valid"
           }
         }
       }
@@ -1459,21 +1614,19 @@
           }
         ],
         "responses": {
+          "404": {
+            "description": "Missing EventStream or Missing View"
+          },
           "200": {
             "description": "OK",
             "content": {
               "text/turtle": {},
               "application/ld+json": {},
               "application/n-quads": {}
             }
-          },
-          "404": {
-            "description": "Missing EventStream or Missing View"
           }
         }
-      }
-    },
-    "/admin/api/v1/eventstreams/{collectionName}/views/{view}": {
+      },
       "delete": {
         "tags": [
           "Views"
@@ -1492,7 +1645,7 @@
             "example": "event-stream"
           },
           {
-            "name": "view",
+            "name": "viewName",
             "in": "path",
             "description": "The name of deleted view",
             "required": true,

diff --git a/docs/_sass/core/markdown.scss b/docs/_sass/core/markdown.scss
@@ -47,7 +47,7 @@
     font-size: $body-font-size;
   }
 
-  // ruby highlight fixed, TODO: line number display
+  // ruby highlight fixed
   figure {
     margin: 0;
   }

diff --git a/docs/_sass/lib/@primer/css/base/base.scss b/docs/_sass/lib/@primer/css/base/base.scss
@@ -36,7 +36,6 @@ strong {
 
 // Horizontal lines
 //
-// TODO-MDO: Remove `.rule` from everywhere and replace with `<hr>`s
 hr,
 .rule {
   height: 0;

diff --git a/docs/_sass/lib/@primer/css/buttons/button.scss b/docs/_sass/lib/@primer/css/buttons/button.scss
@@ -250,7 +250,6 @@
   );
 }
 
-// Solid buttons TODO: Deprecate?
 //
 //
 .btn-blue {

diff --git a/docs/_sass/lib/@primer/css/buttons/misc.scss b/docs/_sass/lib/@primer/css/buttons/misc.scss
@@ -153,7 +153,6 @@
 }
 
 // Social button count
-// TODO: Deprecate? Use BtnGroup instead?
 
 .btn-with-count {
   float: left;

diff --git a/docs/_sass/lib/@primer/css/forms/form-control.scss b/docs/_sass/lib/@primer/css/forms/form-control.scss
@@ -206,7 +206,6 @@ textarea.form-control {
     // stylelint-disable-next-line primer/spacing
     margin: 0 30px 0 0;
 
-    dt, // TODO: Deprecate
     .form-group-header {
       label {
         display: inline-block;
-Original file line number
+Diff line change
@@ Expand Up / @@ -36,7 +36,6 @@ strong { @@
     // Horizontal lines
     //
-    // TODO-MDO: Remove `.rule` from everywhere and replace with `<hr>`s
     hr,
     .rule {
       height: 0;
@@ Expand Down @@