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

Adds APIs docs to the new structure #1339

Merged
merged 2 commits into from
Jul 25, 2023

Conversation

infomiho
Copy link
Contributor

Adds APIs docs with Javscript/Typescript toggle.

It also explains how to add CORS support if you want to use the APIs from the client (a common question).

@infomiho infomiho added the documentation Improvements or additions to documentation label Jul 21, 2023
@infomiho infomiho mentioned this pull request Jul 21, 2023
42 tasks
Copy link
Member

@Martinsos Martinsos left a comment

Choose a reason for hiding this comment

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

Did a very quick read, left 1 comment, looking good from the distance!

```

#### Making sure CORS works
Since the APIs don't use the default middleware like Operations do to make APIs as flexible as possible. As a side-effect, you need to make sure CORS is enabled for your APIs to use them on the client.
Copy link
Member

Choose a reason for hiding this comment

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

Since here doesn't really fit.

@infomiho infomiho merged commit 08f3a18 into docs-restructuring Jul 25, 2023
4 checks passed
@infomiho infomiho deleted the docs-restructuring-apis branch July 25, 2023 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants