boavizta / pcr-si_dataformat

IS Footprint Dataformat

Intro

This repository is intended to offer a technical standard for data exchange, regarding Information Systems (IS) environmental footprints. This is a follow-up from the working group on Product Category Rule for Information Systems.

Currently defined :

• A request format, in request.json, to submit an IS
• A response format, in response.json, to deliver an IS environmental footprint

Not defined :

Each calculation tool will have to manage and explain its management of the following subjects:

• Default mode management, for the different phases of the life cycle (equipment model, electricity mix, etc.)
• Confidentiality and data processing/recording policy

Authors :

Members of the Working Group on PCR IS are members of the following entities :

• Alliance GreenIT
• ADEME
• Boavizta
• GreenIT.fr
• Institut du Numérique Responsable
• Ministère de la Transition Ecologique
• Orange
• Resilio
• Sopra Steria

Contact

Please contact [email protected] or a repo admin for any question.

pcr-si_dataformat's Issues

ImpactObject definition

Trying to represents impacts in a json schema leads to question: should we make all fields of an impact object mandatory ?

My understanding in the draft response.json and https://github.com/Boavizta/PCR-SI_dataformat/blob/main/ImpactObject.md is that we tend to define impacts objects as an fixed list of all (4) licecycle steps X all (18) indicators.

{
            "BLD" : {
                  "GWP": 123,
                  "ADPe": 13,
                  "ADPf": 23,
                  "WU": 12,
                  "...": ...
            },
            "DIS" : {
                  "GWP": 123,
                  "ADPe": 13,
                  "ADPf": 23,
                  "WU": 12,
                  "...": ...
             },
            "USE" : {
                  "GWP": 123,
                  "ADPe": 13,
                  "ADPf": 23,
                  "WU": 12,
                  "...": ...
            },
            "EOL" : {
                   "GWP": 123,
                  "ADPe": 13,
                  "ADPf": 23,
                  "WU": 12,
                  "...": ...
            }
}

Should we use arrays instead (maybe with explictly named properties) that would allow unknwown values to not appear ?

Formalize data format using a json schema

So far our repository contains examples of data.

To make the proposed format truly interoperable (or standard) we need to provide a format definition against which a specific data file can be validated.

JSON schema should be a good way to represent it: https://json-schema.org/learn/getting-started-step-by-step#create

We should provide it as part of the repository.

Formalize OAS3.0 data format

Purpose to formalize pcr data format in OAS 3..0 with light API