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

Add missing id/name fields to context schema docs #1360

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

kriswest
Copy link
Contributor

@kriswest kriswest commented Sep 19, 2024

supersedes #1233

Adds missing id and name fields from the context base schema to context schemas that use them (but don't define sub-properties) so that they show up in documentation correctly, in the following types:

  • Contact
  • ContactList
  • Country
  • InstrumentList
  • OrderList
  • Organization
  • Portfolio
  • Position
  • TradeList

Also fixes:

  • Rendering of internal references (e.g. internal $refs to $defs or definitions used in a schema), which was broken in ChatSearchCriteria (which defines a SearchCriteria element).
  • Bulleting of polymorphic array items (oneOf, anyOf etc.)
  • A number of broken links that have slipped through in other PRs which docusaurus reports on a manual build

@kriswest kriswest added this to the 2.2 candidates milestone Sep 19, 2024
@kriswest kriswest requested a review from a team September 19, 2024 13:53
@kriswest kriswest requested a review from a team as a code owner September 19, 2024 13:53
Copy link

netlify bot commented Sep 19, 2024

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit 93cf6fd
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/66ec2cc0a8afb500081da7c2
😎 Deploy Preview https://deploy-preview-1360--fdc3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@hughtroeger hughtroeger left a comment

Choose a reason for hiding this comment

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

Looks good! All the names and ids are there and the updated links navigate as expected.

@kriswest kriswest merged commit 02e9a2a into main Sep 20, 2024
22 checks passed
@kriswest kriswest deleted the missing-fields-in-context-docs branch September 20, 2024 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants