From f5193ba20de51dfd9d696ade2d5219c3cdc5d1ae Mon Sep 17 00:00:00 2001 From: Russell Hofvendahl Date: Tue, 31 Oct 2023 08:17:38 -0700 Subject: [PATCH 1/2] fix: remove superfluous value term --- docs/openapi/components/schemas/common/EDDShape.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/openapi/components/schemas/common/EDDShape.yml b/docs/openapi/components/schemas/common/EDDShape.yml index 60df4ea68..bb5d2d81f 100644 --- a/docs/openapi/components/schemas/common/EDDShape.yml +++ b/docs/openapi/components/schemas/common/EDDShape.yml @@ -234,7 +234,7 @@ properties: type: number $linkedData: term: dateUncertaintyDays - '@id': https://schema.org/value + '@id': http://rs.tdwg.org/dwc/terms/measurementAccuracy visitType: title: Visit Type description: Purpose of visit to area for collected data. From 5b108c3906896549e60f4eebb58157692b08dba4 Mon Sep 17 00:00:00 2001 From: Russell Hofvendahl Date: Tue, 31 Oct 2023 09:09:03 -0700 Subject: [PATCH 2/2] chore: replace schema value terms with more descriptive alternatives --- .../schemas/common/AgricultureActivity.yml | 2 +- .../common/AgricultureInspectionGeneric.yml | 2 +- .../components/schemas/common/EDDShape.yml | 2 +- .../schemas/common/EDDShapeMeta.yml | 2 +- .../components/schemas/common/FSMAProduct.yml | 4 ++-- .../common/FoodGradeInspectionSample.yml | 4 ++-- .../FoodGradeInspectionSampleProperty.yml | 4 ++-- .../schemas/common/NAISMADateTime.yml | 2 +- .../schemas/common/Phytosanitary.yml | 2 +- .../schemas/common/TemperatureReading.yml | 4 ++-- .../USDAPPQ449RTemperatureCalibration.yml | 2 +- .../common/USDASpecialtyCrops237AForm.yml | 2 +- .../credentials/MexicoEInvoiceCredential.yml | 20 ++++++++++++------- docs/openapi/openapi.yml | 12 +++++++++++ 14 files changed, 41 insertions(+), 23 deletions(-) diff --git a/docs/openapi/components/schemas/common/AgricultureActivity.yml b/docs/openapi/components/schemas/common/AgricultureActivity.yml index b1666c832..cf5b45c09 100644 --- a/docs/openapi/components/schemas/common/AgricultureActivity.yml +++ b/docs/openapi/components/schemas/common/AgricultureActivity.yml @@ -54,7 +54,7 @@ properties: type: string $linkedData: term: activityType - '@id': https://schema.org/value + '@id': https://schema.org/description agricultureProduct: title: Product List description: Agricultural Product the Activity was performed on if known diff --git a/docs/openapi/components/schemas/common/AgricultureInspectionGeneric.yml b/docs/openapi/components/schemas/common/AgricultureInspectionGeneric.yml index 2e4918307..62b126998 100644 --- a/docs/openapi/components/schemas/common/AgricultureInspectionGeneric.yml +++ b/docs/openapi/components/schemas/common/AgricultureInspectionGeneric.yml @@ -82,7 +82,7 @@ properties: type: boolean $linkedData: term: inspectorCounted - '@id': https://schema.org/value + '@id': https://vocabulary.uncefact.org/applicableSpecifiedAction additionalProperties: false required: - type diff --git a/docs/openapi/components/schemas/common/EDDShape.yml b/docs/openapi/components/schemas/common/EDDShape.yml index bb5d2d81f..c40d45d17 100644 --- a/docs/openapi/components/schemas/common/EDDShape.yml +++ b/docs/openapi/components/schemas/common/EDDShape.yml @@ -57,7 +57,7 @@ properties: type: string $linkedData: term: occurrenceStatus - '@id': https://schema.org/value + '@id': http://rs.tdwg.org/dwc/iri/measurementValue status: title: Status description: Status of the population at time of recording. diff --git a/docs/openapi/components/schemas/common/EDDShapeMeta.yml b/docs/openapi/components/schemas/common/EDDShapeMeta.yml index 803a1d5a7..15d43310a 100644 --- a/docs/openapi/components/schemas/common/EDDShapeMeta.yml +++ b/docs/openapi/components/schemas/common/EDDShapeMeta.yml @@ -246,7 +246,7 @@ properties: $ref: ./QuantitativeValue.yml $linkedData: term: treatmentArea - '@id': https://schema.org/value + '@id': http://rs.tdwg.org/dwc/iri/measurementValue plantsTreated: title: Plants Treated description: Number of plants treated to control invasive population. diff --git a/docs/openapi/components/schemas/common/FSMAProduct.yml b/docs/openapi/components/schemas/common/FSMAProduct.yml index 3a5d6adb2..27e1a68ca 100644 --- a/docs/openapi/components/schemas/common/FSMAProduct.yml +++ b/docs/openapi/components/schemas/common/FSMAProduct.yml @@ -33,14 +33,14 @@ properties: type: number $linkedData: term: quantity - '@id': https://schema.org/value + '@id': https://vocabulary.uncefact.org/applicableQuantity unit: title: Unit description: The unit of measure used to describe this product. type: string $linkedData: term: unit - '@id': https://schema.org/unitText + '@id': https://vocabulary.uncefact.org/applicableQuantityUnitTypeCode additionalData: title: Additional Data description: Additional Key Data Elements (KDEs). diff --git a/docs/openapi/components/schemas/common/FoodGradeInspectionSample.yml b/docs/openapi/components/schemas/common/FoodGradeInspectionSample.yml index ec0be90ac..ca993f535 100644 --- a/docs/openapi/components/schemas/common/FoodGradeInspectionSample.yml +++ b/docs/openapi/components/schemas/common/FoodGradeInspectionSample.yml @@ -22,14 +22,14 @@ properties: type: number $linkedData: term: sampleSizeValue - '@id': https://schema.org/value + '@id': https://vocabulary.uncefact.org/applicableQuantity sampleSizeUnits: title: Sample Size Units description: Units used, e.g. "items", "lbs", "kg". type: string $linkedData: term: sampleSizeUnits - '@id': https://schema.org/unitText + '@id': https://vocabulary.uncefact.org/applicableQuantityUnitTypeCode sampleProperties: title: Sample Properties description: Properties of the current sample, indicating information such as "25 green/breakers", "4 percent decay or soft", "0 percent off-size". diff --git a/docs/openapi/components/schemas/common/FoodGradeInspectionSampleProperty.yml b/docs/openapi/components/schemas/common/FoodGradeInspectionSampleProperty.yml index 7cadce4b7..7c90c22cf 100644 --- a/docs/openapi/components/schemas/common/FoodGradeInspectionSampleProperty.yml +++ b/docs/openapi/components/schemas/common/FoodGradeInspectionSampleProperty.yml @@ -22,14 +22,14 @@ properties: type: string $linkedData: term: propertyName - '@id': https://schema.org/name + '@id': https://vocabulary.uncefact.org/parameterValue propertyValue: title: Property Value description: Value of the sample property observed (e.g. "0", "SIL CT", "Yes"). type: string $linkedData: term: propertyValue - '@id': https://schema.org/value + '@id': https://vocabulary.uncefact.org/measuredValue additionalProperties: false required: - type diff --git a/docs/openapi/components/schemas/common/NAISMADateTime.yml b/docs/openapi/components/schemas/common/NAISMADateTime.yml index a9e98f12e..15630c7ce 100644 --- a/docs/openapi/components/schemas/common/NAISMADateTime.yml +++ b/docs/openapi/components/schemas/common/NAISMADateTime.yml @@ -29,7 +29,7 @@ properties: type: number $linkedData: term: dateAccuracyDays - '@id': https://schema.org/value + '@id': http://rs.tdwg.org/dwc/iri/measurementMethod additionalProperties: false required: - type diff --git a/docs/openapi/components/schemas/common/Phytosanitary.yml b/docs/openapi/components/schemas/common/Phytosanitary.yml index 58d6e2aa3..de5192e85 100644 --- a/docs/openapi/components/schemas/common/Phytosanitary.yml +++ b/docs/openapi/components/schemas/common/Phytosanitary.yml @@ -168,7 +168,7 @@ properties: type: string $linkedData: term: inspectionType - '@id': https://schema.org/value + '@id': https://vocabulary.uncefact.org/inspectionStandard notes: title: Inspection Notes description: >- diff --git a/docs/openapi/components/schemas/common/TemperatureReading.yml b/docs/openapi/components/schemas/common/TemperatureReading.yml index 321be736c..1b61f9be4 100644 --- a/docs/openapi/components/schemas/common/TemperatureReading.yml +++ b/docs/openapi/components/schemas/common/TemperatureReading.yml @@ -22,7 +22,7 @@ properties: type: string $linkedData: term: bulbNumber - '@id': https://schema.org/identifier + '@id': https://vocabulary.uncefact.org/identification tests: title: Tests description: A list of temperature readings at 0 C (32 F). @@ -31,7 +31,7 @@ properties: type: number $linkedData: term: tests - '@id': https://schema.org/value + '@id': https://vocabulary.uncefact.org/actualMeasure additionalProperties: false required: - type diff --git a/docs/openapi/components/schemas/common/USDAPPQ449RTemperatureCalibration.yml b/docs/openapi/components/schemas/common/USDAPPQ449RTemperatureCalibration.yml index 56d51c45e..196bcc552 100644 --- a/docs/openapi/components/schemas/common/USDAPPQ449RTemperatureCalibration.yml +++ b/docs/openapi/components/schemas/common/USDAPPQ449RTemperatureCalibration.yml @@ -64,7 +64,7 @@ properties: type: string $linkedData: term: flagCode - '@id': https://schema.org/value + '@id': https://vocabulary.uncefact.org/identification shipsOfficer: title: Ship's Officer description: The ship's officer. diff --git a/docs/openapi/components/schemas/common/USDASpecialtyCrops237AForm.yml b/docs/openapi/components/schemas/common/USDASpecialtyCrops237AForm.yml index 2ef4bf560..e07b53cf5 100644 --- a/docs/openapi/components/schemas/common/USDASpecialtyCrops237AForm.yml +++ b/docs/openapi/components/schemas/common/USDASpecialtyCrops237AForm.yml @@ -91,7 +91,7 @@ properties: type: boolean $linkedData: term: countByInspector - '@id': https://schema.org/values + '@id': https://vocabulary.uncefact.org/applicableSpecifiedAction additionalRemarks: title: Additional Remarks description: Any additional remarks regarding the application. diff --git a/docs/openapi/components/schemas/credentials/MexicoEInvoiceCredential.yml b/docs/openapi/components/schemas/credentials/MexicoEInvoiceCredential.yml index c2108c39e..f0dcb5908 100644 --- a/docs/openapi/components/schemas/credentials/MexicoEInvoiceCredential.yml +++ b/docs/openapi/components/schemas/credentials/MexicoEInvoiceCredential.yml @@ -897,7 +897,7 @@ example: |- "Invoice" ], "taxIdNumber": "88800012345", - "relatedDocuments" : [ + "relatedDocuments": [ { "type": "LinkedDocument", "documentId": "a5d1ca6c-2c06-4039-9ff9-a75d7a695c8d", @@ -936,9 +936,11 @@ example: |- } } }, - "itemsShipped" : [ + "itemsShipped": [ { - "type": ["TradeLineItem"], + "type": [ + "TradeLineItem" + ], "name": "Rebar", "description": "Round Rebar used for Construction", "productIdentifier": "rn19082-a", @@ -951,7 +953,7 @@ example: |- } ], "shipment": { - "type" : [ + "type": [ "Shipment" ], "termsOfDelivery": "full payment before shipment", @@ -1000,16 +1002,20 @@ example: |- "priceCurrency": "USD", "discounts": [ { - "type": ["Discount"], + "type": [ + "Discount" + ], "appliedTo": "subtotal", "discount": "10%", "reason": "First time customer" } ] }, - "paymentDetails" : [ + "paymentDetails": [ { - "type":["PaymentDetails"], + "type": [ + "PaymentDetails" + ], "beneficiaryName": "American Prime Steel Inc.", "beneficiaryAddress": { "type": [ diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml index 4c0aa7981..3d43de163 100644 --- a/docs/openapi/openapi.yml +++ b/docs/openapi/openapi.yml @@ -2660,6 +2660,18 @@ paths: $ref: './components/schemas/credentials/MasterBillOfLadingCredential.yml' + /schemas/credentials/MexicoEInvoiceCredential.yml: + get: + tags: + - credentials + responses: + '200': + content: + application/yml: + schema: + $ref: './components/schemas/credentials/MexicoEInvoiceCredential.yml' + + /schemas/credentials/MillTestReportCredential.yml: get: tags: