fix: use defined term TEA Artifact while artefact in descriptions

Signed-off-by: Pavel Shukhman <[email protected]>

Author: taleodor

api-flow/publisher.md

@@ -19,7 +19,7 @@ sequenceDiagram
     Vendor ->> tea_component: POST to /v1/component with the TEA PI and component version as the payload
     tea_component ->> Vendor: Component is created and a TEA Component ID is returned
 
-    Vendor ->> tea_collection: POST to /v1/collection with the TEA Component ID as the and the artefact as payload
+    Vendor ->> tea_collection: POST to /v1/collection with the TEA Component ID and the artefact as payload
     tea_collection ->> Vendor: Collection is created with the collection ID returned
 
 ```
@@ -40,7 +40,7 @@ sequenceDiagram
     tea_component ->> Vendor: Component is created and a TEA Component ID is returned
 
     Note over Vendor,TEA Component: Add an artefact (e.g. SBOM)
-    Vendor ->> tea_collection: POST to /v1/collection with the TEA Component ID as the and the artefact as payload
+    Vendor ->> tea_collection: POST to /v1/collection with the TEA Component ID and the artefact as payload
     tea_collection ->> Vendor: Collection is created with the collection ID returned
 
 ```
@@ -58,6 +58,6 @@ sequenceDiagram
     Vendor ->> tea_component: GET to /v1/component with the TEA PI to get the latest version
     tea_component ->> Vendor: Component will be returned
 
-    Vendor ->> tea_collection: POST to /v1/collection with the TEA Component ID as the and the artefact as payload
+    Vendor ->> tea_collection: POST to /v1/collection with the TEA Component ID and the artefact as payload
     tea_collection ->> Vendor: Collection is created with the collection ID returned
 ```

doc/tea-usecases.md

@@ -7,7 +7,7 @@ a..."
 The use cases are divided in two categories:
 
 * Use cases for __customers__ (end-users, manufacturers) to find a repository with 
-  Transparency Artefacts for a single unit purchased
+  Transparency artefacts for a single unit purchased
 * Use cases where there are different __products__
   * This applies after discovery where we need to handle various things a customer may 
     buy as a single unit

spec/generators/java-webclient.yaml

@@ -3,9 +3,9 @@ outputDir: /local/out/java-webclient
 generatorName: java
 additionalProperties:
   library: webclient
-  artefactDescription: Transparency Exchange API Java Webclient
-  artefactId: tea-api-webclient
-  artefactUrl: https://github.com/CycloneDX/transparency-exchange-api
+  artifactDescription: Transparency Exchange API Java Webclient
+  artifactId: tea-api-webclient
+  artifactUrl: https://github.com/CycloneDX/transparency-exchange-api
   invokerPackage: org.cyclonedx.tea.webclient
   apiPackage: org.cyclonedx.tea.webclient.api
   modelPackage: org.cyclonedx.tea.webclient.model
@@ -23,5 +23,5 @@ additionalProperties:
   asyncNative: true
   generateBuilders: true
   parentGroupId: org.sonatype.buildsupport
-  parentArtefactId: public-parent
+  parentArtifactId: public-parent
   parentVersion: 50

spec/openapi.yaml

@@ -354,30 +354,30 @@ paths:
           $ref: "#/components/responses/404-object-by-id-not-found"
       tags:
         - TEA Component Release
-  /artefact/{uuid}:
+  /artifact/{uuid}:
     get:
-      description: Get metadata for specific TEA artefact
-      operationId: getArtefact
+      description: Get metadata for specific TEA Artifact
+      operationId: getArtifact
       parameters:
         - name: uuid
           in: path
           required: true
-          description: UUID of TEA Artefact in the TEA server
+          description: UUID of TEA Artifact in the TEA server
           schema:
             "$ref": "#/components/schemas/uuid"
       responses:
         '200':
-          description: Requested TEA Artefact metadata found and returned
+          description: Requested TEA Artifact metadata found and returned
           content:
             application/json:
               schema:
-                "$ref": "#/components/schemas/artefact"
+                "$ref": "#/components/schemas/artifact"
         '400':
           $ref: "#/components/responses/400-invalid-request"
         '404':
           $ref: "#/components/responses/404-object-by-id-not-found"
       tags:
-        - TEA Artefact
+        - TEA Artifact
   /discovery:
     get:
       description: Discovery endpoint which resolves TEI into product release UUID.
@@ -786,7 +786,7 @@ components:
             updateReason:
               type: INITIAL_RELEASE
               comment: Initial collection for this release
-            artefacts:
+            artifacts:
               - uuid: 1cb47b95-8bf8-3bad-a5a4-0d54d86e10ce
                 name: Build SBOM
                 type: BOM
@@ -835,20 +835,20 @@ components:
         updateReason:
           description: Reason for the update/release of the TEA Collection object.
           "$ref": "#/components/schemas/collection-update-reason"
-        artefacts:
+        artifacts:
           type: array
-          description: List of TEA artefact objects.
+          description: List of TEA Artifact objects.
           items:
-            "$ref": "#/components/schemas/artefact"
+            "$ref": "#/components/schemas/artifact"
       examples:
         # Documents in the latest release of Log4j Core
         - uuid: 4c72fe22-9d83-4c2f-8eba-d6db484f32c8
           version: 3
           date: 2024-12-13T00:00:00Z
           updateReason:
-            type: ARTEFACT_UPDATED
+            type: ARTIFACT_UPDATED
             comment: VDR file updated
-          artefacts:
+          artifacts:
             - uuid: 1cb47b95-8bf8-3bad-a5a4-0d54d86e10ce
               name: Build SBOM
               type: BOM
@@ -889,9 +889,9 @@ components:
       enum:
         - INITIAL_RELEASE
         - VEX_UPDATED
-        - ARTEFACT_UPDATED
-        - ARTEFACT_ADDED
-        - ARTEFACT_REMOVED
+        - ARTIFACT_UPDATED
+        - ARTIFACT_ADDED
+        - ARTIFACT_REMOVED
 
     collection-belongs-to-type:
       type: string
@@ -901,38 +901,38 @@ components:
         - PRODUCT_RELEASE
 
     #
-    # TEA Artefact and related objects
+    # TEA Artifact and related objects
     #
-    artefact:
+    artifact:
       type: object
       description: A security-related document
       properties:
         uuid:
-          description: UUID of the TEA Artefact object.
+          description: UUID of the TEA Artifact object.
           "$ref": "#/components/schemas/uuid"
         name:
           type: string
-          description: Artefact name
+          description: Name of TEA Artifact
         type:
-          description: Type of artefact
-          "$ref": "#/components/schemas/artefact-type"
+          description: Type of TEA Artifact
+          "$ref": "#/components/schemas/artifact-type"
         distributionTypes:
           type: array
           description: |
-            List of component distributions types that this artefact applies to.
-            If absent, the artefact applies to all distributions.
+            List of component distributions types that this TEA Artifact applies to.
+            If absent, the TEA Artifact applies to all distributions.
           items:
             type: string
             description: |
-              The `id` of the component format that this artefact applies to.
+              The `id` of the component format that this TEA Artifact applies to.
         formats:
           type: array
           description: |
             List of objects with the same content, but in different formats.
             The order of the list has no significance.
           items:
-            "$ref": "#/components/schemas/artefact-format"
-    artefact-type:
+            "$ref": "#/components/schemas/artifact-format"
+    artifact-type:
       type: string
       description: Specifies the type of external reference.
       enum:
@@ -947,7 +947,7 @@ components:
         - THREAT_MODEL
         - VULNERABILITIES
         - OTHER
-    artefact-format:
+    artifact-format:
       type: object
       description: A security-related document in a specific format
       properties:
@@ -956,18 +956,18 @@ components:
           description: The MIME type of the document
         description:
           type: string
-          description: A free text describing the artefact
+          description: A free text describing the TEA Artifact
         url:
           type: string
-          description: Direct download URL for the artefact
+          description: Direct download URL for the TEA Artifact
           format: url
         signatureUrl:
           type: string
-          description: Direct download URL for an external signature of the artefact
+          description: Direct download URL for an external signature of the TEA Artifact
           format: url
         checksums:
           type: array
-          description: List of checksums for the artefact
+          description: List of checksums for the TEA Artifact
           items:
             "$ref": "#/components/schemas/checksum"
     checksum:
@@ -1221,7 +1221,7 @@ tags:
   - name: TEA Product Release
   - name: TEA Component
   - name: TEA Component Release
-  - name: TEA Artefact
+  - name: TEA Artifact
   - name: TEA Discovery
 externalDocs:
   description: Transparency Exchange API specification