Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.

Fix TM API /publish/CrStates response example#6660

Merged
zrhoffman merged 1 commit intoapache:masterfrom
ocket8888:docs/tm-api-fix
Mar 15, 2022
Merged

Fix TM API /publish/CrStates response example#6660
zrhoffman merged 1 commit intoapache:masterfrom
ocket8888:docs/tm-api-fix

Conversation

@ocket8888
Copy link
Contributor

The current response example for the TM API's /publish/CrStates endpoint isn't syntactically valid, so syntax highlighting is broken. This PR fixes that.

I also linked some :term:s to the glossary, and removed a couple of repeated property explanations.


Which Traffic Control components are affected by this PR?

  • Documentation

What is the best way to verify this PR?

Make sure the docs build, check the rendered example to verify syntax highlighting is done.

If this is a bugfix, which Traffic Control versions contained the bug?

PR submission checklist

  • This PR has tests
  • This PR has documentation
  • This PR has a CHANGELOG.md entry
  • This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY

@ocket8888 ocket8888 added bug something isn't working as intended documentation related to documentation low impact affects only a small portion of a CDN, and cannot itself break one labels Mar 15, 2022
@zrhoffman zrhoffman merged commit ffe7e91 into apache:master Mar 15, 2022
@ocket8888 ocket8888 deleted the docs/tm-api-fix branch March 15, 2022 22:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

bug something isn't working as intended documentation related to documentation low impact affects only a small portion of a CDN, and cannot itself break one

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants