Skip to content
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

[Site] Schema needs to be updated on the site #4879

Closed
paulcam206 opened this issue Oct 5, 2020 · 5 comments
Closed

[Site] Schema needs to be updated on the site #4879

paulcam206 opened this issue Oct 5, 2020 · 5 comments
Assignees
Labels

Comments

@paulcam206
Copy link
Member

paulcam206 commented Oct 5, 2020

Although we've updated the current schema to the 1.3.0 version of the schema with #4884, this issue tracks whether we wish to revisit how we handle schema versioning.

Looks like this will require a bit more planning -- specifically, the currently published schema is our 1.3.0 schema. Should newer schemas are published at versioned URLs (e.g. https://adaptivecards.io/schemas/1.4.0/adaptive-card.json). We need to square our structure with our card author guidance. Should the unversioned URL be considered "latest", or should it be the 1.3 schema encased in amber?

Some points:

  • cards generated by the designer are all emitted with the unversioned schema url
  • our samples all use the unversioned schema url
  • due to this, loading any of our samples in the designer has some suboptimal behaviors (note that these aren't deficiencies in the designer):
    • properties introduced after the latest version aren't validated (e.g. "isRequired": "steve" weren't flagged for an invalid type when we we on the 1.1 schema)
  • our docs don't have any guidance around the value of $schema
  • I'm not sure if we've ever publicly communicated the versioned schema URLs
  • we should turn on schema validation for our samples if we're not already covering it
@paulcam206 paulcam206 added the Bug label Oct 5, 2020
@ghost ghost added the Triage-Needed label Oct 5, 2020
@ghost ghost added this to the 20.10 milestone Oct 5, 2020
@ghost ghost added the Area-Inconsistency Bugs around renderer inconsistencies across different platforms label Oct 5, 2020
@ghost
Copy link

ghost commented Oct 5, 2020

please review this issue for target Milestone, Inconsistencies & Priority upon triage.

@ghost ghost added the High Priority label Oct 5, 2020
@paulcam206 paulcam206 self-assigned this Oct 5, 2020
@paulcam206 paulcam206 removed the Area-Inconsistency Bugs around renderer inconsistencies across different platforms label Oct 5, 2020
@ghost
Copy link

ghost commented Oct 5, 2020

Hi @paulcam206. We have acknowledged this issue report. Please continue to follow this issue for updates/progress/questions.

@paulcam206
Copy link
Member Author

@matthidinger / @dclaux / @shalinijoshi19 FYI

@shalinijoshi19
Copy link
Member

@RebeccaAnne ? I dont think we got traction on this from Paul's end before he left on leave. Can you pick it up to determine when/how this will need to be fixed - time for 20.10?

@RebeccaAnne
Copy link
Contributor

@shalinijoshi19 This tracks the larger conversation around how we want to handle versioning our schema. #4884 is the immediate issue of updating our current schema to the latest version. I've moved that one back into 20.10, but this one represents a longer term conversation.

@ghost ghost added the AdaptiveCards v20.11 label Nov 5, 2020
@RebeccaAnne RebeccaAnne modified the milestones: 20.11, Backlog Nov 10, 2020
@ghost ghost removed the AdaptiveCards v20.11 label Nov 10, 2020
@RebeccaAnne RebeccaAnne removed this from the Backlog milestone May 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants