Here are a couple quick mockups to see if I'm understanding this correctly from the design side:

Option 1

Option 2

I would need a bit of help coming up with good helper text and an example.

nice! thanks @mwilliams -- that exactly captures options 1 + 2

fwiw i would probably place this field higher up -- like in the Details section - maybe above or below the Description field because it's a vital/critical part of the instrument

Happy to provide helper text - how about something like:

Option 1:

Schema Base Type:
The default web or app base schema title for event validation of this instrument's stream.
- app base
- web base

Option 2:

Schema Title:
To use the web base schema, enter `analytics/product_metrics/web/base`.
To use the app base schema, enter `analytics/product_metrics/app/base`.
To use a custom schema, enter the exact schema title that is used in a corresponding production event schema i.e. `analytics/mobile_apps/product_metrics/android_find_in_page_interaction`.

Note that submission of this form will create a stream which accepts events with a JSONSchema title that matches this field value. The event schema must exist in production in order for events in this stream to validate.
See https://wikitech.wikimedia.org/wiki/Event_Platform/Stream_Configuration#schema_title

A little verbose but something like this that is super explicit - we can also provide links to Wikitech docs like
https://wikitech.wikimedia.org/wiki/Event_Platform/Schemas
https://wikitech.wikimedia.org/wiki/Event_Platform/Schemas/Guidelines
https://wikitech.wikimedia.org/wiki/Event_Platform/Stream_Configuration

Thanks! Updated those and Option 2 is probably requires too much text. I agree it is confusing without it but its so much text in a form like this that people will most likely skip over it and end up getting stuck.

I attempted a variation of both options that allows for a third radio field if we think a custom schema is required. That variation also has a link for more info or help as well.

Option 1

Option 2 (Leaning against this option)

Option 3 / Variation if we decide we do need custom schema option.

oooh - i like the option 3 variation -- maybe we can just hide the text input and if a user chooses custom, it can appear below it?

also i think i put this Q in your slides -- for the phab ticket field -- it's just a text input right? limited to one url?
should we allow for multiple tickets?
maybe a comma delimited string of task ids? and then we can construct urls from them

i.e. T123456, T987654

Posted some ideas about the phab ticket field question at https://phabricator.wikimedia.org/T366394.

Regarding the option 3 variation...I like the idea of the user understanding what to expect when they select the custom radio field. Hiding the input field could be surprising when they do select it and realize they need to fill out a blank input field. So I lean slightly against hiding, making sure its a disabled input field until the custom radio field probably does the trick.

making sure its a disabled input field until the custom radio field probably does the trick.

perfect - we will do this if we go with Option 3

@mwilliams Option 3 looks great!

@cjming I am confused a bit by the term " base": by "app base" do you mean "mobile app core schema"? Same question for "web base".

I want to suggest "Which schema are you using? More Info." instead of "The default web or app base schema title for event validation of this instrument's stream." We can elaborate in the link for additional context. I'm not sure it's important that the users know that the schema is used for event validation... let me know if I am wrong.

hi @mwilliams @VirginiaPoundstone cc @phuedx @WDoranWMF

stop the presses - I updated this ticket's description to pivot the new field from schema title to stream name

After much discussion with DE and within our DP subteam, we are keeping stream definition limited to static config only. This means for the MPIC app, we need to know production stream names to track instruments that need to validate against custom schemas derived from MP base schemas.

For instruments that are using the web/app base schemas, we will already know the stream name (and hence schema title) so if we need to support custom schemas (derived from MP base schemas), we need a Stream Name field for this use case.

Thanks for the update @cjming! I don't totally follow all of this but is there a certain set of stream names and this should be a select? Or just an open text input again?

hi @mwilliams

is there a certain set of stream names and this should be a select?

Eventually yes - Option 3 in the ticket description is the ideal scenario but for MVP I believe we're fine with a single text input field

Now I'm second-guessing if a single text input field suffices -- I just filed T366951 which depends on knowing if the stream uses a web base or an app base schema (and even if the custom schema is derived from web or app base).

Pending outcome of T366951#9872355, Option 3 might be needed here.

Yesterday @VirginiaPoundstone, @cjming, and I discussed this and decided that we should proceed with option 3. But that a text input for "Custom" couldn't be the longterm solution since typing in a custom schema would go wrong more times than right and that it probably should be a select.

You can see the status of this on the Codex side of things here - https://phabricator.wikimedia.org/T363416

@mwilliams @VirginiaPoundstone turns out we can hit a public api (my bad - i had it in my head that we had to hit the Gerrit api) to get the stream name so rather than a text input, we can go with an autocomplete lookup field as a separate field for the custom stream name.

If that works for the alpha release, we can have this single-value autocomplete lookup field be disabled when the app or web radios are selected (and have it be prepopulated with the app or web base stream name) and enabled when the custom radio is selected.

Does this make sense?

cc @Sfaci

sfaci merged https://gitlab.wikimedia.org/repos/data-engineering/mpic/-/merge_requests/52

Fix schema type, stream name toggling