You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: decisions/log/0041-version-simplification.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ Starting PACT 4.x the properties `version` and `updated` will be made obsolete.
46
46
Any 3.x implementation of the PACT API does not need to implement any reasoning to distinguish between major and minor changes.
47
47
48
48
### Backwards and forwards compatibility
49
-
Changes originating in 3.x will be handled correctly by 2.x API's: any change involve a new ID and a link back to the old ID. So, in terms of 2.x, the change is a *major* one, which will deprecate previous PCF's.
49
+
Changes originating in 3.x will be handled correctly by 2.x API's: any change involve a new ID and a link back to the old ID. So, in terms of 2.x, the change is a *major* one, which will deprecate previous PCFs.
50
50
The one exception of a change originating in 3.x is the deprecation of an old PCF *without* it being replaced by a new one. In this case the ID will not change, but the status does (and be set to `Deprecated`).
51
51
52
52
Major changes originating in 2.x will be be handled correctly by 3.x API's.
Copy file name to clipboardexpand all lines: decisions/log/0042-add-filter-to-async-api.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -73,9 +73,9 @@ As a consequence, after consulting with the Tech WG on 15/1/2025 a limited list
73
73
*`companyId` (string) can be 1 or more company ID's. Will return all footprints with corresponding id's in the `companyIds` attribute. Note that a footprint itself can also have multiple company IDs.
74
74
*`geography` (string) can be 1 or more geographic specifiers. Values specified can denote `geographicRegion` or `geographyCountry` or `geographyCountrySubdivision`. Will return all footprints within the specified geography.
75
75
*`classification` (string) can be 1 or more product classifications. Will return all footprints with corresponding values in the `productClassifications` attribute. Note that a footprint itself can have multiple classifications.
76
-
*`validOn` (date-string) will match all PCF's which where valid on the date specified: footprint.validityPeriodBegin <= validOn AND validFrom <= footprint.validityPeriodEnd
77
-
*`validAfter` (date-string) will match PCF's whith validAfter < footprint.validityPeriodBegin
78
-
*`validBefore` (date-string) will match PCF's whith validBefore > footprint.validityPeriodEnd
76
+
*`validOn` (date-string) will match all PCFs which where valid on the date specified: footprint.validityPeriodBegin <= validOn AND validFrom <= footprint.validityPeriodEnd
77
+
*`validAfter` (date-string) will match PCFs whith validAfter < footprint.validityPeriodBegin
78
+
*`validBefore` (date-string) will match PCFs whith validBefore > footprint.validityPeriodEnd
79
79
*`status` (string) Can be "Active" or "Deprecated"
80
80
***MAYBE?**`pfId` (string) Search for a specific Product Footprint Id. Note that this is synonymous with calling `/footprints/{pfid}`
Exchanging PCF's asynchronously requires **both** the [=data owner=]**and** the [=data recipient=] to run a PACT conformant host system, **both** sides being able to initiate communication to each other.
178
+
Exchanging PCFs asynchronously requires **both** the [=data owner=]**and** the [=data recipient=] to run a PACT conformant host system, **both** sides being able to initiate communication to each other.
179
179
180
180
181
181
### Requesting a PCF
@@ -204,16 +204,16 @@ Refer to [[#api-action-events]] for detailed request and response formats.
204
204
205
205
## Synchronous retrieval
206
206
207
-
The synchronous part of te API allows for immediate retrieval of PCF's. Refer to [[#api-action-list]] and [[#api-action-get]] for detailed request and response formats.
207
+
The synchronous part of te API allows for immediate retrieval of PCFs. Refer to [[#api-action-list]] and [[#api-action-get]] for detailed request and response formats.
208
208
209
209
210
-
### Getting multiple PCF's
210
+
### Getting multiple PCFs
211
211
212
-
The `ListFootprints` action allows for directly retrieving multiple PCF's. Starting from version 3.0, host systems
212
+
The `ListFootprints` action allows for directly retrieving multiple PCFs. Starting from version 3.0, host systems
213
213
must provide filtering on a minimum set of criteria.
214
214
215
215
1. The data recipient authenticates with the data owner.
216
-
2. The data recipient calls the `/footprints` endpoint, optionally providing a filter with search criteria and a limit to obtain a list of PCF's.
216
+
2. The data recipient calls the `/footprints` endpoint, optionally providing a filter with search criteria and a limit to obtain a list of PCFs.
217
217
3. After validating the request, the data owner returns a 2xx status code and the list of {<ProductFootprint>} objects. On error the data owner returns a relevant HTTP error code. For details, see [#rest-api]
Copy file name to clipboardexpand all lines: spec/v3/openapi.yaml
+4-4
Original file line number
Diff line number
Diff line change
@@ -902,7 +902,7 @@ components:
902
902
description: |
903
903
If present, a description of any allocation rules applied and the rationale explaining how the selected approach aligns with [=PACT Methodology=] rules (see Section 3.3.1.4).
904
904
summary: |
905
-
Description of the allocation rules applied to the PCF's foreground data
905
+
Description of the allocation rules applied to the PCFs foreground data
906
906
including an explanation of the underlying reasons (way of allocating
907
907
all activities from your manufacturing steps to the declared unit).
908
908
type: string
@@ -1521,23 +1521,23 @@ components:
1521
1521
validOn:
1522
1522
name: validOn
1523
1523
description: |
1524
-
If present, MUST match all PCF's which where valid on the date specified: footprint.validityPeriodBegin <= validOn AND validFrom <= footprint.validityPeriodEnd
1524
+
If present, MUST match all PCFs which where valid on the date specified: footprint.validityPeriodBegin <= validOn AND validFrom <= footprint.validityPeriodEnd
1525
1525
in: query
1526
1526
schema:
1527
1527
type: string
1528
1528
format: date-time
1529
1529
validAfter:
1530
1530
name: validAfter
1531
1531
description: |
1532
-
if present, MUST match PCF's whith validAfter < footprint.validityPeriodBegin
1532
+
if present, MUST match PCFs whith validAfter < footprint.validityPeriodBegin
1533
1533
in: query
1534
1534
schema:
1535
1535
type: string
1536
1536
format: date-time
1537
1537
validBefore:
1538
1538
name: validBefore
1539
1539
description: |
1540
-
if present, MUST match PCF's whith validBefore > footprint.validityPeriodEnd
1540
+
if present, MUST match PCFs whith validBefore > footprint.validityPeriodEnd
Copy file name to clipboardexpand all lines: spec/v3/rest-api.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -236,11 +236,11 @@ Note: Optional filtering specified in version 2.2+ (based on OData4) is NOW DEPR
236
236
: `classification` array(string)
237
237
:: if present, MUST be 1 or more product classifications. Will return all footprints with corresponding values in the `productClassifications` attribute. Note that a footprint itself can have multiple classifications.
238
238
: `validOn` (date-string)
239
-
:: if present, MUST match all PCF's which where valid on the date specified: footprint.validityPeriodBegin <= validOn AND validFrom <= footprint.validityPeriodEnd
239
+
:: if present, MUST match all PCFs which where valid on the date specified: footprint.validityPeriodBegin <= validOn AND validFrom <= footprint.validityPeriodEnd
240
240
: `validAfter` (date-string)
241
-
:: if present, MUST match PCF's whith validAfter < footprint.validityPeriodBegin
241
+
:: if present, MUST match PCFs whith validAfter < footprint.validityPeriodBegin
242
242
: `validBefore` (date-string)
243
-
:: if present, MUST match PCF's whith validBefore > footprint.validityPeriodEnd
243
+
:: if present, MUST match PCFs whith validBefore > footprint.validityPeriodEnd
244
244
: `status` (string)
245
245
:: If Present, MUST be either be "Active" or "Deprecated"
246
246
@@ -577,11 +577,11 @@ with
577
577
: `classification` array(string)
578
578
:: if present, MUST be 1 or more product classifications. Will return all footprints with corresponding values in the `productClassifications` attribute. Note that a footprint itself can have multiple classifications.
579
579
: `validOn` (date-string)
580
-
:: if present, MUST match all PCF's which where valid on the date specified: footprint.validityPeriodBegin <= validOn AND validFrom <= footprint.validityPeriodEnd
580
+
:: if present, MUST match all PCFs which where valid on the date specified: footprint.validityPeriodBegin <= validOn AND validFrom <= footprint.validityPeriodEnd
581
581
: `validAfter` (date-string)
582
-
:: if present, MUST match PCF's whith validAfter < footprint.validityPeriodBegin
582
+
:: if present, MUST match PCFs whith validAfter < footprint.validityPeriodBegin
583
583
: `validBefore` (date-string)
584
-
:: if present, MUST match PCF's whith validBefore > footprint.validityPeriodEnd
584
+
:: if present, MUST match PCFs whith validBefore > footprint.validityPeriodEnd
585
585
: `status` (string)
586
586
:: If Present, MUST be either be "Active" or "Deprecated"
0 commit comments