search

OpenEoX / openeox

This project aims to standardize the representation and management of EOL and EOS product information across the industry.
https://openeox.org/
MIT License
25 stars 4 forks source link

Create a more detailed draft documentation for the schema #11

Closed santosomar closed 1 year ago

santosomar commented 1 year ago

Perhaps add a README.md to in the new /schema folder.

santosomar commented 1 year ago

Open Product Lifecycle Framework (OPLF) JSON Schema

This JSON schema provides a standard format for representing product lifecycle milestones including End-of-Life (EOL) and End-of-Support (EOS) information for products.

Schema Required Properties

The following properties are required:

Explanation of Schema Properties

  1. $schema: This property references the schema definition (schema_t) and specifies the schema against which the JSON object must be validated. The valid value for this property is "https://openplf.org/eol-eos-schema-0.2.0.json".

  2. creationTimestamp: This property represents the timestamp when the record was created. The timestamp must follow the RFC 3339 standard for date-time formatting. For example: "2023-05-01T12:00:00Z".

  3. EOLDate: This property contains the End of Life (EOL) date of the product, indicating the date after which the product is no longer produced or maintained. The value can either be a date-time format following the RFC 3339 standard or the string "tba" (To Be Announced) if the EOL date is not yet determined.

  4. supplierId: This property contains a unique identifier for the supplier or service provider. It is a string with a minimum length of 1 character.

  5. supplierName: This property contains the name of the supplier or service provider. It is a string with a minimum length of 1 character.

  6. productId: This property contains the unique product identifier for the product. It is a string with a minimum length of 1 character and references the productId_t definition.

  7. productName: This property contains the name of the product. It is a string with a minimum length of 1 character and references the productName_t definition.

  8. productVersion: This property contains the version or release information of the product. It is a string with a minimum length of 1 character and references the productVersion_t definition.

  9. replacementProduct: This property contains information about the recommended replacement product, if applicable. It is an object with the following required properties:

    • productId: Contains the unique product identifier for the replacement product. It is a string with a minimum length of 1 character and references the productId_t definition.

    • productName: Contains the name of the replacement product. It is a string with a minimum length of 1 character and references the productName_t definition.

    • productVersion: Contains the version or release information of the replacement product. It is a string with a minimum length of 1 character and references the productVersion_t definition.

These properties together allow for a complete and standardized representation of End-of-Life (EOL) and End-of-Support (EOS) information for products.

santosomar commented 1 year ago

I will create the README.md once #10 is merged and approved.