Skip to content

Oonirun v2.1 #301

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Oonirun v2.1 #301

wants to merge 3 commits into from

Conversation

hellais
Copy link
Member

@hellais hellais commented Feb 18, 2025

WIP specification update for OONI Run v2.1

implements ooni/backend#930

Question: do we want to use headers for this or should we instead make a
new post handler which does these in the request body? That would be
slightly more flexible if we would like to use this request to pass
additional data as part of the first request.
Copy link

@sdsantos sdsantos left a comment

Choose a reason for hiding this comment

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

This look to be breaking changes to the schema. Should the endpoints become .../api/v2.1/...?

Same as 4.3 GET the OONI Run descriptor

Note: for dynamically generated run links, this view will only return the
`target_name` and not the `targets` list.

Choose a reason for hiding this comment

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

This way, the users never see the full list of URLs to be tested before installing a Run Link right? Maybe on the mobile clients we need to add a button to see the full list on the web...

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, this is by design though, given that for dynamic test lists (which are currently only derived from the test lists), we cannot know the full list ahead of time as it will change every time you run it.

From the perspective of the UI, we can either show a label that explains these are dynamic and refer to the the test-lists repo to view them. Alternatively we can fetch a batch of URLs from the API endpoint and display that, but make it clear it's just a sample and might change.

],

// (optional) string used to specify during creation what is the label for targets to use.
"targets_name": "websites_list_prioritized",

Choose a reason for hiding this comment

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

This will come from a fixed list of options right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we will have a predefined list of these. The client doesn't necessarily need to be aware of all the targets_name, but we will start off with just the websites target list.

@hellais hellais marked this pull request as ready for review May 5, 2025 11:14
@hellais
Copy link
Member Author

hellais commented May 5, 2025

This look to be breaking changes to the schema. Should the endpoints become .../api/v2.1/...?

The concern here is that inputs might be empty and the clients are not able to read the targets and targets_name

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.

3 participants