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

Set schema for out-of-line annotations #309

Merged

Conversation

gathogojr
Copy link
Collaborator

@gathogojr gathogojr commented Oct 12, 2023

Document how to set schema for out-of-line annotations to address a documentation gap identified from OData/odata.net#2102

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 06c61c7:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/odatalib/v7/edm/define-annotations.md ⚠️Warning View Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md ⚠️Warning View Details
Odata-docs/TOC.yml 💡Suggestion View Details

Odata-docs/odatalib/v7/edm/define-annotations.md

  • Line 10, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Define annotations' is duplicated with other articles: 'odatalib/v7/edm/define-annotations.md(10,1), odatalib/v7/edm/set-annotations-schema.md(10,1)'. First level headings must be unique within a docset.

Odata-docs/odatalib/v7/edm/set-annotations-schema.md

  • Line 10, Column 1: [Warning: duplicate-h1s - See documentation] H1 'Define annotations' is duplicated with other articles: 'odatalib/v7/edm/define-annotations.md(10,1), odatalib/v7/edm/set-annotations-schema.md(10,1)'. First level headings must be unique within a docset.
  • Line 15, Column 32: [Suggestion: link-broken - See documentation] Link '/odatalib/edm/define-annotations' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr force-pushed the docs/2102-set-annotations-schema branch from 06c61c7 to a62a549 Compare October 12, 2023 08:13
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit a62a549:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details

Odata-docs/odatalib/v7/edm/set-annotations-schema.md

  • Line 15, Column 32: [Suggestion: link-broken - See documentation] Link '/odatalib/edm/define-annotations' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr force-pushed the docs/2102-set-annotations-schema branch from a62a549 to 2157ebd Compare October 12, 2023 08:25
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 2157ebd:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr force-pushed the docs/2102-set-annotations-schema branch from 2157ebd to e372cb0 Compare October 12, 2023 08:35
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit e372cb0:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr force-pushed the docs/2102-set-annotations-schema branch from e372cb0 to 24f77cd Compare October 13, 2023 07:26
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 24f77cd:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr force-pushed the docs/2102-set-annotations-schema branch from 24f77cd to 308e063 Compare October 13, 2023 08:27
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 308e063:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr force-pushed the docs/2102-set-annotations-schema branch from 308e063 to cdc5dd2 Compare October 17, 2023 05:26
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit cdc5dd2:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr force-pushed the docs/2102-set-annotations-schema branch from cdc5dd2 to b3a74f5 Compare October 17, 2023 06:03
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit b3a74f5:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • Line 0, Column 0: [Error: taxonomy-api-failed] Call to Taxonomy API failed 'Response status code does not indicate success: 403 (Forbidden).'. Try closing and reopening the PR. If you get this Error again, file an issue.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr closed this Oct 17, 2023
@gathogojr gathogojr reopened this Oct 17, 2023
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit b3a74f5:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

# Set schema for out-of-line annotations
**Applies To**: [!INCLUDE[appliesto-odataclient](../../../includes/appliesto-odatalib-v7.md)]

The Edm library lets you [define annotations](/odata/odatalib/edm/define-annotations) and additionally specify the schema that out-of-line annotations should appear in.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think giving a simple overview of what an out-of-line annotation is will enrich this doc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@ElizabethOkerio The linked page (define annotations) explains both inline and out-of-line annotations so I thought covering the same in this page would be repetitive.

Copy link
Collaborator Author

@gathogojr gathogojr Oct 24, 2023

Choose a reason for hiding this comment

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

@ElizabethOkerio Added a paragraph to introduce annotations (inline & out-of-line)

@gathogojr gathogojr force-pushed the docs/2102-set-annotations-schema branch from b3a74f5 to 5ac6b81 Compare October 24, 2023 09:00
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 5ac6b81:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr force-pushed the docs/2102-set-annotations-schema branch from 5ac6b81 to f7ac9e3 Compare October 24, 2023 17:27
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit f7ac9e3:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/edm/set-annotations-schema.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gathogojr gathogojr merged commit 3c41311 into MicrosoftDocs:main Oct 24, 2023
@gathogojr gathogojr deleted the docs/2102-set-annotations-schema branch October 24, 2023 17:38
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