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

API docs standardization changes #38

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

MikeAdamsMews
Copy link
Contributor

Summary

Some small changes to documentation as part of API standardization initiative. These changes bring the API part of the Booking Engine Guide into line with the other Mews APIs. A couple of other necessary changes were made at the same time. Full list of changes as follows:

  • API: Guidelines renamed to Usage guidelines
  • API: Updated Deprecations page definition of discontinued
  • API: Changed Whitelisting to IP address allowlisting
  • API: Authorization page renamed to Authentication and content rewritten
  • General: Added .gitbook.yaml file with redirect for old authorization page
  • General: Google Tag Manager Configuration title and capitalization adjustments
  • General: Migration off the mews.li domain title adjustment
  • General: Rolled over changelog to 2025

Checklist (general)

  • Documentation follows the Style Guide
  • Changelog dated the day when PR merged
  • Changelog accurately describes all changes
  • All hyperlinks tested
  • SUMMARY.md updated if new pages added

Checklist (API)

  • JSON examples updated
  • Properties in JSON examples in same order as in property tables
  • Changelog highlights the affected endpoints or operations
  • Changelog highlights any deprecations
  • Deprecation Table updated if any deprecations

@MikeAdamsMews MikeAdamsMews self-assigned this Jan 3, 2025
@MikeAdamsMews MikeAdamsMews requested review from a team as code owners January 3, 2025 12:04
@MikeAdamsMews MikeAdamsMews marked this pull request as draft January 3, 2025 12:12
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.

1 participant