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

Perf guidelines #303

Merged
merged 28 commits into from
Mar 14, 2024
Merged

Perf guidelines #303

merged 28 commits into from
Mar 14, 2024

Conversation

habbes
Copy link
Contributor

@habbes habbes commented Aug 11, 2023

Adds section in the docs on performance tips and guidelines. We can use this to document useful tips on performance tuning for OData libraries. I added a different article for each topic, but I had also considered considering all the performance tips in a single article. Let me know which one you prefer.

I added the following articles under the Performance guidelines section:

  • Overview: overview of the section. Didn't have much to write here and I'm not sure it's necessary to have this page. But I thought it makes sense to have a page that explains what this section is about since the different guidelines are independent of each other.
  • Marking the IEdmModel as immutable
  • Using ODataUtf8JsonWriter
  • Disabling writer validations

I also fixed a type in a filename that was resulting in broken URL links (404s).

I also added an article on ODataUtf8JsonWriter for ASP.NET Core OData 8. We have similar articles for ODL and Web API 7, but we didn't have one for ASP.NET Core OData 8.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 50106fb:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ⚠️Warning n/a (file deleted or renamed) Details
Odata-docs/performance/mark-edm-model-immutable.md ⚠️Warning View Details
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md ⚠️Warning View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View

Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md

  • [Warning: file-not-redirected - See documentation] File Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md with URL /odata/odatalib/using-ut8jsonwriter-for-better-performance was deleted without redirection. To avoid broken links, add a redirection.

Odata-docs/performance/mark-edm-model-immutable.md

  • Line 0, Column 0: [Warning: h1-missing - See documentation] H1 is required. Use a single hash (#) followed by a space to create your top-level heading.

Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md

  • Line 0, Column 0: [Warning: h1-missing - See documentation] H1 is required. Use a single hash (#) followed by a space to create your top-level heading.
  • Line 12, Column 480: [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.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/performace/mark-edm-model-immutable.md' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit a0902e0:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ⚠️Warning n/a (file deleted or renamed) Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md 💡Suggestion View Details
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View

Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md

  • [Warning: file-not-redirected - See documentation] File Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md with URL /odata/odatalib/using-ut8jsonwriter-for-better-performance was deleted without redirection. To avoid broken links, add a redirection.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/performace/mark-edm-model-immutable.md' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md

  • Line 14, Column 480: [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.

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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 66fa796:

⚠️ Validation status: warnings

File Status Preview URL Details
.openpublishing.redirection.json ⚠️Warning Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ⚠️Warning n/a (file deleted or renamed) Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md 💡Suggestion View Details
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View

.openpublishing.redirection.json

  • Line 5, Column 82: [Warning: redirection-path-syntax-error] Redirection path syntax is incorrect. 'source_path' should start without '/' and 'source_path_from_root' should start with '/'.

Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md

  • [Warning: file-not-redirected - See documentation] File Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md with URL /odata/odatalib/using-ut8jsonwriter-for-better-performance was deleted without redirection. To avoid broken links, add a redirection.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/performace/mark-edm-model-immutable.md' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md

  • Line 14, Column 480: [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.

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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 5ae1c67:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ⚠️Warning n/a (file deleted or renamed) Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md 💡Suggestion View Details
.openpublishing.redirection.json ✅Succeeded
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View

Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md

  • [Warning: file-not-redirected - See documentation] File Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md with URL /odata/odatalib/using-ut8jsonwriter-for-better-performance was deleted without redirection. To avoid broken links, add a redirection.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/performace/mark-edm-model-immutable.md' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md

  • Line 14, Column 480: [Suggestion: link-broken - See documentation] Link '/odatalib/v7/using-utf8jsonwriter-for-better-performance' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 16e6032:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ⚠️Warning n/a (file deleted or renamed) Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md 💡Suggestion View Details
.openpublishing.redirection.json ✅Succeeded
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View

Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md

  • [Warning: file-not-redirected - See documentation] File Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md with URL /odata/odatalib/using-ut8jsonwriter-for-better-performance was deleted without redirection. To avoid broken links, add a redirection.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performace/mark-edm-model-immutable.md' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md

  • Line 14, Column 480: [Suggestion: link-broken - See documentation] Link '/odatalib/v7/using-utf8jsonwriter-for-better-performance' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 2b6be78:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ⚠️Warning n/a (file deleted or renamed) Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md 💡Suggestion View Details
.openpublishing.redirection.json ✅Succeeded
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View

Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md

  • [Warning: file-not-redirected - See documentation] File Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md with URL /odata/odatalib/using-ut8jsonwriter-for-better-performance was deleted without redirection. To avoid broken links, add a redirection.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performace/mark-edm-model-immutable' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md

  • Line 14, Column 480: [Suggestion: link-broken - See documentation] Link '/odatalib/v7/using-utf8jsonwriter-for-better-performance' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit b471a30:

💡 Validation status: suggestions

File Status Preview URL Details
.openpublishing.redirection.json 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md 💡Suggestion View Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View

.openpublishing.redirection.json

  • Line 5, Column 78: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'odatalib/v7/using-ut8jsonwriter-for-better-performance.md' because redirect URL 'odatalib/v7/using-ut8jsonwriter-for-better-performance' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performace/mark-edm-model-immutable' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md

  • Line 14, Column 480: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 92d66ff:

💡 Validation status: suggestions

File Status Preview URL Details
.openpublishing.redirection.json 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md 💡Suggestion View Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View

.openpublishing.redirection.json

  • Line 5, Column 85: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'odatalib/v7/using-ut8jsonwriter-for-better-performance.md' because redirect URL '/odata/odatalib/v7/using-ut8jsonwriter-for-better-performance' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performace/mark-edm-model-immutable' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md

  • Line 14, Column 480: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit d61f45a:

💡 Validation status: suggestions

File Status Preview URL Details
.openpublishing.redirection.json 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md 💡Suggestion View Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View

.openpublishing.redirection.json

  • Line 5, Column 86: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'odatalib/v7/using-ut8jsonwriter-for-better-performance.md' because redirect URL '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performace/mark-edm-model-immutable' points to a page that doesn't exist. Check the path or URL and update the link.

Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md

  • Line 14, Column 480: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit ae4163c:

💡 Validation status: suggestions

File Status Preview URL Details
.openpublishing.redirection.json 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

.openpublishing.redirection.json

  • Line 5, Column 86: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'odatalib/v7/using-ut8jsonwriter-for-better-performance.md' because redirect URL '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performace/mark-edm-model-immutable' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 84ccfa7:

💡 Validation status: suggestions

File Status Preview URL Details
.openpublishing.redirection.json 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

.openpublishing.redirection.json

  • Line 5, Column 86: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'odatalib/v7/using-ut8jsonwriter-for-better-performance.md' because redirect URL '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performace/mark-edm-model-immutable' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 337fc87:

💡 Validation status: suggestions

File Status Preview URL Details
.openpublishing.redirection.json 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

.openpublishing.redirection.json

  • Line 5, Column 86: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'odatalib/v7/using-ut8jsonwriter-for-better-performance.md' because redirect URL '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performance/mark-edm-model-immutable' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 302ef97:

💡 Validation status: suggestions

File Status Preview URL Details
.openpublishing.redirection.json 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

.openpublishing.redirection.json

  • Line 5, Column 86: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'odatalib/v7/using-ut8jsonwriter-for-better-performance.md' because redirect URL '/odata/odatalib/v7/using-utf8jsonwriter-for-better-performance' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performance/mark-edm-model-immutable' 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:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 1f662cf:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
.openpublishing.redirection.json ✅Succeeded View
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 105, Column 19: [Suggestion: link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-odatautf8jsonwriter-to-improve-serialization-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • 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 398, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/performance/mark-edm-model-immutable' 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:


**Applies To**:[!INCLUDE[appliesto-webapi](../../includes/appliesto-webapi-v8.md)]

`Microsoft.OData.Core` version 7.12.2 introduced a new JSON writer that writes directly to a `Stream` rather than using a `TextWriter`. It also introduced a default implementation of this "stream-based" JSON writer that’s based on .NET’s [`Utf8JsonWriter`](/dotnet/api/system.text.json.utf8jsonwriter). This writer offers better performance than the default JSON writer used in `Microsoft.OData.Core`. To learn more, [visit this page](../../odatalib/v7/using-utf8jsonwriter-for-better-performance.md). In this article, we are going to show you how to configure your ASP.NET Core OData application to use the `Utf8JsonWriter`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The first sentence... I'd rather you talked about the new JSON writer being based on Utf8JsonWriter (or being a wrapper for Utf8JsonWriter) than talk about it writing directly to a Stream as opposed to using a TextWriter.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Makes sense. Should I mention the Stream and TextWriter differences at all? I did so to help explain the name. But I could also remove that and just mention that the writer is based on `Utf8JsonWriter.


**Applies To**:[!INCLUDE[appliesto-webapi](../../includes/appliesto-webapi-v8.md)]

`Microsoft.OData.Core` version 7.12.2 introduced a new JSON writer that writes directly to a `Stream` rather than using a `TextWriter`. It also introduced a default implementation of this "stream-based" JSON writer that’s based on .NET’s [`Utf8JsonWriter`](/dotnet/api/system.text.json.utf8jsonwriter). This writer offers better performance than the default JSON writer used in `Microsoft.OData.Core`. To learn more, [visit this page](../../odatalib/v7/using-utf8jsonwriter-for-better-performance.md). In this article, we are going to show you how to configure your ASP.NET Core OData application to use the `Utf8JsonWriter`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
`Microsoft.OData.Core` version 7.12.2 introduced a new JSON writer that writes directly to a `Stream` rather than using a `TextWriter`. It also introduced a default implementation of this "stream-based" JSON writer that’s based on .NET’s [`Utf8JsonWriter`](/dotnet/api/system.text.json.utf8jsonwriter). This writer offers better performance than the default JSON writer used in `Microsoft.OData.Core`. To learn more, [visit this page](../../odatalib/v7/using-utf8jsonwriter-for-better-performance.md). In this article, we are going to show you how to configure your ASP.NET Core OData application to use the `Utf8JsonWriter`.
`Microsoft.OData.Core` version 7.12.2 introduced a new JSON writer that writes directly to a `Stream` rather than using a `TextWriter`. It also introduced a default implementation of this "stream-based" JSON writer that’s based on .NET’s [`Utf8JsonWriter`](/dotnet/api/system.text.json.utf8jsonwriter). This writer offers better performance than the built-in JSON writer that is used by default in `Microsoft.OData.Core`. To learn more, [visit this page](../../odatalib/v7/using-utf8jsonwriter-for-better-performance.md). In this article, we are going to show you how to configure your ASP.NET Core OData application to use the `Utf8JsonWriter`.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm hesitant about the emphasis on "built-in" her because both writers are built-in.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've rephrased the statement, but omitted the "built-in" term.

Copy link
Contributor

Learn Build status updates of commit 15bd9c5:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/performance/using-utf8jsonwriter.md ⚠️Warning View Details
.openpublishing.redirection.json ✅Succeeded View
OData-docs.sln ✅Succeeded
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/disable-writer-validations.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/performance/overview.md ✅Succeeded View
Odata-docs/TOC.yml ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-utf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

Odata-docs/performance/using-utf8jsonwriter.md

  • Line 18, Column 3: [Warning: learn-site-link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 22, Column 203: [Warning: learn-site-link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance#choosing-a-javascriptencoder' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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:

Copy link
Contributor

Learn Build status updates of commit 78115bb:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/performance/using-utf8jsonwriter.md ⚠️Warning View Details
.openpublishing.redirection.json ✅Succeeded View
OData-docs.sln ✅Succeeded
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/disable-writer-validations.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/performance/overview.md ✅Succeeded View
Odata-docs/TOC.yml ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-utf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

Odata-docs/performance/using-utf8jsonwriter.md

  • Line 18, Column 3: [Warning: learn-site-link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 19, Column 3: [Warning: learn-site-link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-utf8jsonwriter-to-improve-serialization-performance' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 22, Column 203: [Warning: learn-site-link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance#choosing-a-javascriptencoder' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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:

Copy link
Contributor

Learn Build status updates of commit 73c1800:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/performance/using-utf8jsonwriter.md ⚠️Warning View Details
.openpublishing.redirection.json ✅Succeeded View
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/disable-writer-validations.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/performance/overview.md ✅Succeeded View
Odata-docs/TOC.yml ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-utf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

Odata-docs/performance/using-utf8jsonwriter.md

  • Line 18, Column 3: [Warning: learn-site-link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 19, Column 3: [Warning: learn-site-link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-utf8jsonwriter-to-improve-serialization-performance' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 22, Column 203: [Warning: learn-site-link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance#choosing-a-javascriptencoder' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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:

}));
```

## Disabling writer validations when using `Microsoft.AspNetCore.OData` 7 library
Copy link
Contributor

@ElizabethOkerio ElizabethOkerio Mar 5, 2024

Choose a reason for hiding this comment

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

Is this Microsoft.AspNetCore 7 only or even Microsoft.AspNet.OData

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. ODataUtf8JsonWriter is not supported in Microsoft.AspNet.OData because it depends on Utf8JsonWriter which is not supported in .NET Framework.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@habbes I don't think this particular article is related to ODataUtf8JsonWriter, is it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm. You are correct. I had confused this with a different conversation. Let me revert back with a response.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You can do this in AspNet.OData 7 as well using the MapODataServiceRoute method like the MVC routing approach below. The only difference is that the AspNet 7.x configuration setup looks different from the AspNetCore one (there's no Startup class with a Configure method, there's a WebApiConfig class with a Register method that takes a HttpConfiguration argument.

But the OData part is identical. I think readers would still be able to easily adapt this sample to their AspNet.OData code.


`Microsoft.OData.Core` version 7.12.2 introduced a new JSON writer that’s based on .NET’s [`Utf8JsonWriter`](/dotnet/api/system.text.json.utf8jsonwriter). This writer offers better performance than the JSON writer that is used by default in `Microsoft.OData.Core`. To learn more, [visit this page](../../odatalib/v7/using-utf8jsonwriter-for-better-performance.md). In this article, we are going to show you how to configure your ASP.NET Core OData application to use the `Utf8JsonWriter`.

This feature is available in ASP.NET Core OData version 8.0.11 or later.
Copy link
Contributor

@ElizabethOkerio ElizabethOkerio Mar 5, 2024

Choose a reason for hiding this comment

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

I think this is confusing.. Which feature is availabe here? Is it the use of utf8jsonwriter? Somewhere up there you indicated that people can enable utf8jsonwriter in Microsoft.AspNetCore.OData 8.x and 7.x

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 you should make it clear which version of ODL has this change..Then all versions of Microsoft.AspNetCore.OData with that ODL version have the feature.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The feature is available in both 8.x and 7.x. But in 8.x it's only available in 8.0.11 or later, i.e. not available in 8.0.10 earlier. This particular article exists in the WebAPI 8 docs page. There are separate articles in the 7.x docs which specify the minimum version of 7.x supported: https://learn.microsoft.com/en-us/odata/webapi/using-utf8jsonwriter-to-improve-serialization-performance.

The article already mentions which version of ODL introduces this feature: 7.12.2. I think it's also relevant to mention the version of WebAPI 8 that introduces this feature. Someone may be using an older version like 8.0.7. I think it's easier to tell them this is feature requires 8.0.11 or later than to ask them to go through all the 8.x versions to and look for the ones that depend on ODL 7.12.2 or later.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@habbes I know it'd involve a bit more work, but would it be better to capture the supported versions here:
image
That is add includes specific to the version(s) that support ODataUtf8JsonWriter. That way the doc doesn't say at the top that the feature is supported in the V8 and then in the body it says 8.0.11.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@habbes Another suggestion would be to rephrase the paragraph to immediately establish the connection between Microsoft.OData.Core 7.12.2 and Microsoft.AspNetCore.OData 8.0.11, e.g.:

The Microsoft.AspNetCore.OData library takes a dependency on the Microsoft.OData.Core library. Microsoft.OData.Core 7.12.2 introduced a new JSON writer that's based on .NET's Utf8JsonWriter. This new writer offers better performance than the JSON writer that is used by default. Reference Microsoft.AspNetCore.OData 8.0.11 or higher to use the new writer. To learn more, visit this page.

In this article, we are going to show you how to configure your ASP.NET Core OData application to use the Utf8JsonWriter.

Then you don't need the sentence: "This feature is available in ASP.NET Core OData version 8.0.11 or later."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@habbes I know it'd involve a bit more work, but would it be better to capture the supported versions here: image That is add includes specific to the version(s) that support ODataUtf8JsonWriter. That way the doc doesn't say at the top that the feature is supported in the V8 and then in the body it says 8.0.11.

@gathogojr do you mean adding an includes specific for 8.0.11 and later? Or? I'm not sure I understood the statement. Note that this particular article sits in the Web API 8 docs tree, which is separate from the Web API 7 docs tree.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@gathogojr I've rephrased the statement as suggestion, except that I didn't mention that part about "The Microsoft.AspNetCore.OData library takes a dependency on Microsoft.OData.Core library". Not sure if that's really necessary. But open to adding it if you think otherwise.

Copy link
Contributor

Learn Build status updates of commit affe33b:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/performance/using-utf8jsonwriter.md 💡Suggestion View Details
.openpublishing.redirection.json ✅Succeeded View
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/disable-writer-validations.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/performance/overview.md ✅Succeeded View
Odata-docs/TOC.yml ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-utf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

Odata-docs/performance/using-utf8jsonwriter.md

  • Line 18, Column 3: [Suggestion: learn-site-link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 19, Column 3: [Suggestion: learn-site-link-broken - See documentation] Link '/odata/webapi-8/tutorials/using-utf8jsonwriter-to-improve-serialization-performance' points to a learn site page that doesn't exist. Check the path or URL and update the link.
  • Line 22, Column 203: [Suggestion: learn-site-link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance#choosing-a-javascriptencoder' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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:

@@ -39,7 +39,7 @@ builder.AddService<IStreamBasedJsonWriterFactory>(sp => DefaultStreamBasedJsonWr

### No support for streaming writes

The default `JsonWriter` implements the `IJsonStreamWriter` and `IJsonStreamWriterAsync` interfaces. This interface allows you to pipe data directly from an input stream to the output destination. This may be useful when writing the contents of large binary file into base-64 output without buffering everything in memory first. The new `ODataUtf8JsonWriter` does not yet implement this interface, which means input from a stream will be buffered entirely in memory before being written out to the destination. If your use case requires writing from a stream input, consider using the default `JsonWriter`.
The default `JsonWriter` implements the `IJsonStreamWriter` and `IJsonStreamWriterAsync` interfaces. This interface allows you to pipe data directly from an input stream to the output destination. This may be useful when writing the contents of large binary file into base-64 output without buffering everything in memory first. The `Utf8JsonWriter`-based writer does not yet implement this interface, which means input from a stream will be buffered entirely in memory before being written out to the destination. If your use case requires writing from a stream input, consider using the default `JsonWriter`. Follow [this issue](https://github.com/OData/odata.net/issues/2422) to find out when this will be resolved.

### Supported .NET versions

Copy link
Collaborator

Choose a reason for hiding this comment

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

Line below:
"on .NET Core 3.1 and above (i.e. .NET 6 etc.)" => "on .NET Core 3.1 and above"

Copy link
Collaborator

Choose a reason for hiding this comment

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

In any case .NET Core 5 applies too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't mention .NET 5 because it was already out of support by then. I wasn't sure if someone who's not conversant with the .NET evolution would know that .NET 6+ is in the same line of success as .NET Core 3.1 given that name change from .NET Core to .NET. Maybe I could say .NET Core 3.1 and .NET 5+

Copy link
Contributor

Learn Build status updates of commit e1eae09:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/performance/using-utf8jsonwriter.md 💡Suggestion View Details
.openpublishing.redirection.json ✅Succeeded View
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/performance/disable-writer-validations.md ✅Succeeded View
Odata-docs/performance/mark-edm-model-immutable.md ✅Succeeded View
Odata-docs/performance/overview.md ✅Succeeded View
Odata-docs/TOC.yml ✅Succeeded View
Odata-docs/webapi-8/tutorials/using-utf8jsonwriter-to-improve-serialization-performance.md ✅Succeeded View

Odata-docs/performance/using-utf8jsonwriter.md

  • Line 22, Column 203: [Suggestion: learn-site-link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance#choosing-a-javascriptencoder' points to a learn site page that doesn't exist. Check the path or URL and update the link.

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 merged commit 712d53d into MicrosoftDocs:main Mar 14, 2024
2 checks passed
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