Skip to content

Clarify TEA Product fields #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ppkarwasz
Copy link
Contributor

Modifies the documentation of the TEA product and completes its JSON schema according to what was discussed at the Koala Workshop.

This PR is an initial schema to define the main TEA objects. It will be further expanded in other PRs that address specific TEA objects.

Signed-off-by: Piotr P. Karwasz <[email protected]>
@ppkarwasz ppkarwasz requested review from oej and madpah as code owners April 16, 2025 12:29
@ppkarwasz ppkarwasz mentioned this pull request Apr 16, 2025
1 task
Signed-off-by: Piotr P. Karwasz <[email protected]>
Modifies the documentation of the TEA product and completes its JSON schema.

Signed-off-by: Piotr P. Karwasz <[email protected]>
@ppkarwasz ppkarwasz force-pushed the feat/clarify-product branch from 12656b1 to f33d2bc Compare April 16, 2025 12:33
@ppkarwasz ppkarwasz marked this pull request as draft April 16, 2025 14:45
@ppkarwasz
Copy link
Contributor Author

I will move the changes to product into the OpenAPI document.

@@ -39,7 +39,7 @@ The working group has produced a list of use cases and requirements for the prot

## Data model

- [TEA Product index](tea-index/tea-index.md): This is the starting point. A "product" is something for sale. The [Transparency Exchange Identifier, TEI](/discovery/readme.md) points to a single product.
- [TEA Product index](spec/product): This is the starting point. A "product" is something for sale. The [Transparency Exchange Identifier, TEI](/discovery/readme.md) points to a single product.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [TEA Product index](spec/product): This is the starting point. A "product" is something for sale. The [Transparency Exchange Identifier, TEI](/discovery/readme.md) points to a single product.
- [TEA Product index](spec/product.md): This is the starting point. A "product" is something for sale. The [Transparency Exchange Identifier, TEI](/discovery/readme.md) points to a single product.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why we have JSON schemas separate to the OpenAPI Spec, which can define everything in one place and save repetition @ppkarwasz ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #111 (comment)

I still haven't updated the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants