Update openapi.yaml (#113)

src/coordinate_transformation_api/assets/openapi.yaml

@@ -5,10 +5,10 @@ info:
   version: "" # replaced in code
   description: >
     The Coordinate Transformation API performs coordinate transformations on GeoJSON and CityJSON files using the official RDNAPTRANS™
-    transformation procedure.
+    transformation procedure and other transformations defined or recommended by NSGI.
   contact:
     name: NSGI
-    email: info@nsgi.nl
+    email: rd@kadaster.nl
     url: https://www.nsgi.nl
   termsOfService: https://creativecommons.org/licenses/by/4.0/
   x-keywords:
@@ -92,7 +92,7 @@ paths:
       operationId: "get-crss"
       tags:
         - CRS
-      summary: Get all supported CRSs in the transformation API
+      summary: Get all CRSs supported by the transformation API
       description: Get all available coordinate reference systems (CRSs)
       responses:
         "200":
@@ -140,7 +140,7 @@ paths:
         - Density
       summary: >
         Check density of (multi)polygon and (multi)linestring geometries based on geodesic (ellipsoidal great-circle) distance
-        in ETRF2000 (EPSG:9067|EPSG:7931)
+        on the ellipsoid of the (base) CRS
       description: |
         Check density of polygon and linestring geometries. Returns a `DensityCheckReport` containing a FeatureCollection containing all line segments exceeding the `maxSegmentLength/Deviation` (if any).
       parameters:
@@ -213,7 +213,8 @@ paths:
       tags:
         - Density
       summary: >
-        Densify (multi)polygon and (multi)linestring geometries using the geodesic (ellipsoidal great-circle) distance in ETRF2000 (EPSG:9067|EPSG:7931)
+        Densify (multi)polygon and (multi)linestring geometries using the geodesic (ellipsoidal great-circle) trajectory
+        on the ellipsoid of the (base) CRS
       description: >
         A POST endpoint that accepts a GeoJSON object and densifies the geometries using the `max-segment-length` threshold.
       parameters:
@@ -295,11 +296,11 @@ paths:
       tags:
         - Transform
       summary: >
-        Transforms the given coordinates of a point from the source CRS to the
+        Transformation of the given coordinates of a point from the source CRS to the
         target CRS.
       description: >
         A GET endpoint that accepts coordinates of a given source CRS
-        and transforms it to the provided target CRS. The input coordinates are
+        and performs the transformation to the provided target CRS. The input coordinates are
         a comma separated list of numbers that can represent the `xy`, `lat/lon` or `lon/lat` with or without a third height dimension.
 
         Source CRS and target CRS can be defined through either the query parameters or the request headers. Order of precedence is: query parameters > request headers.
@@ -345,9 +346,9 @@ paths:
       tags:
         - Transform
       summary: >
-        Transforms the given geometries from the source CRS to the target CRS
+        Transformation of the given geometries from the source CRS to the target CRS
       description: >
-        A POST endpoint that accepts a file of a given source CRS and transforms it to the provided target CRS.
+        A POST endpoint that accepts a file in a given source CRS and performs the transformation to the provided target CRS.
       parameters:
         - $ref: "#/components/parameters/sourceCrs"
         - $ref: "#/components/parameters/targetCrs"
@@ -770,7 +771,7 @@ components:
       schema:
         $ref: "#/components/schemas/DensityCheckResultEnum"
     epoch:
-      description: Epoch of the response (if defined through transformation)
+      description: Epoch of the coordinates in the response (if defined in the input)
       schema:
         $ref: "#/components/schemas/Epoch"
   parameters:
@@ -791,7 +792,7 @@ components:
       schema:
         $ref: "#/components/schemas/CrsHeaderEnum"
     coordinates:
-      description: Coordinates of the query point as comma seperated list, see `source-crs` parameter for order and required number of the coordinates
+      description: Coordinates of the query point as comma seperated list, see `source-crs` parameter for order and required dimension of the coordinates
       in: query
       name: coordinates
       required: true
@@ -801,7 +802,7 @@ components:
         $ref: "#/components/schemas/Coords"
     densityCheck:
       description: |
-        Run density-check on input before transforming. Will result in HTTP 400 response if density-check fails.
+        Run density-check on input before transformation. Will result in HTTP 400 response if density-check fails.
       in: query
       name: density-check
       example: True