Skip to content

Commit f079fe7

Browse files
committed
docs: fix typos: PCFs without apostroph
1 parent 9c9d17b commit f079fe7

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

decisions/log/0041-version-simplification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Starting PACT 4.x the properties `version` and `updated` will be made obsolete.
4646
Any 3.x implementation of the PACT API does not need to implement any reasoning to distinguish between major and minor changes.
4747

4848
### 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.
5050
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`).
5151

5252
Major changes originating in 2.x will be be handled correctly by 3.x API's.

decisions/log/0042-add-filter-to-async-api.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ As a consequence, after consulting with the Tech WG on 15/1/2025 a limited list
7373
* `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.
7474
* `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.
7575
* `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
7979
* `status` (string) Can be "Active" or "Deprecated"
8080
* **MAYBE?**`pfId` (string) Search for a specific Product Footprint Id. Note that this is synonymous with calling `/footprints/{pfid}`
8181

spec/v3/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ This chapter provides examples for inter-company business cases related to the e
175175

176176
## Asynchronous Exchange ## {#business-cases-async-events}
177177

178-
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.
179179

180180

181181
### Requesting a PCF
@@ -204,16 +204,16 @@ Refer to [[#api-action-events]] for detailed request and response formats.
204204

205205
## Synchronous retrieval
206206

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.
208208

209209

210-
### Getting multiple PCF's
210+
### Getting multiple PCFs
211211

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
213213
must provide filtering on a minimum set of criteria.
214214

215215
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.
217217
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]
218218

219219

spec/v3/openapi.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -902,7 +902,7 @@ components:
902902
description: |
903903
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).
904904
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
906906
including an explanation of the underlying reasons (way of allocating
907907
all activities from your manufacturing steps to the declared unit).
908908
type: string
@@ -1521,23 +1521,23 @@ components:
15211521
validOn:
15221522
name: validOn
15231523
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
15251525
in: query
15261526
schema:
15271527
type: string
15281528
format: date-time
15291529
validAfter:
15301530
name: validAfter
15311531
description: |
1532-
if present, MUST match PCF's whith validAfter < footprint.validityPeriodBegin
1532+
if present, MUST match PCFs whith validAfter < footprint.validityPeriodBegin
15331533
in: query
15341534
schema:
15351535
type: string
15361536
format: date-time
15371537
validBefore:
15381538
name: validBefore
15391539
description: |
1540-
if present, MUST match PCF's whith validBefore > footprint.validityPeriodEnd
1540+
if present, MUST match PCFs whith validBefore > footprint.validityPeriodEnd
15411541
in: query
15421542
schema:
15431543
type: string

spec/v3/rest-api.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -236,11 +236,11 @@ Note: Optional filtering specified in version 2.2+ (based on OData4) is NOW DEPR
236236
: `classification` array(string)
237237
:: 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.
238238
: `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
240240
: `validAfter` (date-string)
241-
:: if present, MUST match PCF's whith validAfter < footprint.validityPeriodBegin
241+
:: if present, MUST match PCFs whith validAfter < footprint.validityPeriodBegin
242242
: `validBefore` (date-string)
243-
:: if present, MUST match PCF's whith validBefore > footprint.validityPeriodEnd
243+
:: if present, MUST match PCFs whith validBefore > footprint.validityPeriodEnd
244244
: `status` (string)
245245
:: If Present, MUST be either be "Active" or "Deprecated"
246246

@@ -577,11 +577,11 @@ with
577577
: `classification` array(string)
578578
:: 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.
579579
: `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
581581
: `validAfter` (date-string)
582-
:: if present, MUST match PCF's whith validAfter < footprint.validityPeriodBegin
582+
:: if present, MUST match PCFs whith validAfter < footprint.validityPeriodBegin
583583
: `validBefore` (date-string)
584-
:: if present, MUST match PCF's whith validBefore > footprint.validityPeriodEnd
584+
:: if present, MUST match PCFs whith validBefore > footprint.validityPeriodEnd
585585
: `status` (string)
586586
:: If Present, MUST be either be "Active" or "Deprecated"
587587
: <dfn>PFRequestComment</dfn>

0 commit comments

Comments
 (0)