Clarified uniqueness constraints for identifiers. #454

CHANGELOG.md

@@ -43,6 +43,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `GET /`: Removed the superfluous default value for `currency`. [#423](https://github.com/Open-EO/openeo-api/issues/423)
 - Reflect that the `debug` process has been renamed to `inspect`.
 - `GET /credentials/oidc`: Clarify that clients may add additional scopes
+- Clarified uniqueness constraints for identifiers. [#454](https://github.com/Open-EO/openeo-api/issues/454)
 
 ## [1.1.0] - 2021-05-17
 

openapi.yaml

@@ -250,7 +250,7 @@ info:
     
     **Users** MUST follow the schema for user-defined processes as in [`GET /process_graphs/{process_graph_id}`](#operation/describe-custom-process) to define new processes. This includes:
 
-    * Choosing a intuitive name as process id, consisting of only letters (a-z), numbers and underscores. It MUST be unique across the user-defined processes.
+    * Choosing a intuitive name as process id, consisting of only letters (a-z), numbers and underscores. It MUST be unique per user across the user-defined processes.
     * Defining the algorithm as a process graph.
     * Optionally, specifying the additional metadata for processes.
 
@@ -1839,7 +1839,7 @@ paths:
                         id:
                           type: string
                           description: >-
-                            A **unique** identifier for the OpenID Connect Provider to
+                            A per-backend **unique** identifier for the OpenID Connect Provider to
                             be as prefix for the Bearer token.
                           pattern: '[\d\w]{1,20}'
                         issuer:
@@ -2282,7 +2282,7 @@ paths:
     parameters:
       - name: process_graph_id
         in: path
-        description: Unique identifier for a user-defined process.
+        description: Per-user unique identifier for a user-defined process.
         required: true
         schema:
           $ref: '#/components/schemas/process_id'
@@ -4379,7 +4379,8 @@ components:
         'cube:dimensions':
           title: STAC Collection Cube Dimensions
           description: |-
-            Uniquely named dimensions of the data cube.
+            The named default dimensions of the data cube.
+            Names must be unique per collection.
 
             The keys of the object are the dimension names. For
             interoperability, it is RECOMMENDED to use the
@@ -5431,7 +5432,7 @@ components:
     job_id:
       type: string
       description: >-
-        Unique identifier of the batch job, generated by the
+        Per-backend unique identifier of the batch job, generated by the
         back-end during creation. MUST match the specified pattern.
       pattern: '^[\w\-\.~]+$'
       example: a3cca2b2aa1e3b5b
@@ -5591,8 +5592,8 @@ components:
     service_id:
       type: string
       description: >-
-        Unique identifier of the secondary web service, generated by the
-        back-end during creation. MUST match the specified pattern.
+        A per-backend unique identifier of the secondary web service, generated
+        by the back-end during creation. MUST match the specified pattern.
       pattern: '^[\w\-\.~]+$'
       example: wms-a3cca9
     resource_parameter:
@@ -6283,14 +6284,14 @@ components:
     service_id:
       name: service_id
       in: path
-      description: Unique secondary web service identifier.
+      description: Identifier of the secondary web service.
       required: true
       schema:
         $ref: '#/components/schemas/service_id'
     job_id:
       name: job_id
       in: path
-      description: Unique job identifier.
+      description: Identifier of the batch job.
       required: true
       schema:
         $ref: '#/components/schemas/job_id'