HACKATHON: Add calendarhero api #110
Draft
+1,540
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Alkasai
reviewed
Sep 27, 2022
Comment on lines
+38
to
+66
| enum: | ||
| - popular | ||
| - recent | ||
| - a | ||
| - b | ||
| - c | ||
| - d | ||
| - e | ||
| - f | ||
| - g | ||
| - h | ||
| - i | ||
| - j | ||
| - k | ||
| - l | ||
| - m | ||
| - 'n' | ||
| - o | ||
| - p | ||
| - q | ||
| - r | ||
| - s | ||
| - t | ||
| - u | ||
| - v | ||
| - w | ||
| - x | ||
| - 'y' | ||
| - z |
There was a problem hiding this comment.
Is this file just an example of how to add CH documentation?
There was a problem hiding this comment.
I imported the existing API docs from https://api.calendarhero.com/documentation and then changed the server and auth details.
To maintain this file going forward we have two options:
- Improve the existing CH API docs and set up a build process to automatically make the same changes that I did while copying updates to this repo.
- Use this repo as the source of truth and follow this guide to edit the docs using Stoplight Studio.
If we decide to change from a raw proxy to actually rewriting the request and response bodies (so we can filter out some deprecated fields) then option 2 is the way to go.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for the calendar hero APIs that are routed through the api-gateway as a proxy in #179
You can preview the docs on this branch here
Note: I don't want to merge this until we add actual documentation to each of the fields and APIs. We should also decide what to do about Vendasta users that should be able to access multiple CalendarHero instances and partner service accounts.
https://github.com/orgs/vendasta/teams/external-apis @jaycroll @Alkasai