Skip to content

Commit

Permalink
add screenshots, fix main article, fix redirects
Browse files Browse the repository at this point in the history
  • Loading branch information
jayk-u committed Nov 29, 2024
1 parent 78d6522 commit 1b410c2
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 13 deletions.
19 changes: 9 additions & 10 deletions src/_help/documentation-experience/api-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ title: API Explorer (Beta)
- TOC
{:toc}

The API Explorer is a new feature in beta with limited access. You can request access by following this link.
> The API Explorer is a new feature in beta with limited access. You can request access by following this link.
{: .info}

## What is the API Explorer?

Expand All @@ -15,15 +16,15 @@ The API Explorer allows you to test an API in real-world conditions directly fro

The API Explorer is accessible at any time via a button at the top of your documentation (and remains visible as you scroll). Each operation also features a button that opens the API Explorer for that specific operation.

[screenshot of the button]
![](/images/help/explorer-button.png)

If you haven’t opened the API Explorer from a specific operation, you can select one from the corresponding menu.

[screenshot of the API Explorer]
![](/images/help/explorer-operation-selection.png)

We identify the required fields directly from the definition file, making it easier for you to fill out the request, detecting whether it’s a boolean, date, etc. Fill in the expected information to execute the request and receive a response.

[screenshot of a response]
![](/images/help/explorer-response.png)

### Sharing

Expand All @@ -32,9 +33,9 @@ It’s possible to share a request setup, which is useful for showing an example
> This URL will never share your authentication parameters or the response.
{: .info}

[screenshot of sharing]
![](/images/help/explorer-share.png)

If the API documentation has been updated after the share URL was generated, you will be notified when attempting to use it. You will then have the option to switch to an updated version of the operation. Note that in this case, new elements will no longer be pre-filled.
If the API documentation has been updated after the share URL was generated, the Explorer will notify you that the pre-filled fields may have changed and display a link to the API changelog for a more detailed review of the changes.

> The curl commands generated when filling out the form are copyable.
{: .tip}
Expand All @@ -50,15 +51,13 @@ To ensure optimal compatibility and total confidentiality, we chose to let the u

To avoid this situation, we created our own proxy, designed to ensure that requests sent from a browser are processed without error by an API’s servers, all while maintaining confidentiality and security: **cors toujours**.

This proxy is hosted outside our infrastructure to ensure data security. Its open-source code is available via this GitHub repository: [link to the repo].

For more on our approach and the decisions behind its creation, we’ve prepared a more detailed article: [link to the blog post].
This proxy is hosted outside our infrastructure to ensure data security. Its open-source code will soon be made available to the community.

### Authentication

We support authentication for APIs that require prior authentication. Two options are available: via HTTP (Basic/Bearer) or via API keys.

[screenshot of the button and field to fill in]
![](/images/help/explorer-auth.png)

> When sharing a request, this authentication information is never transmitted.
{: .info}
Expand Down
6 changes: 3 additions & 3 deletions src/_redirects
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
https://help.bump.sh/markdown-support https://docs.bump.sh/help/enhance-documentation-content/markdown-support/
https://help.bump.sh/markdown-support https://docs.bump.sh/help/documentation-experience/markdown-support/
https://help.bump.sh/references https://docs.bump.sh/help/specifications-support/references/
https://help.bump.sh/* https://docs.bump.sh/:splat 301!
/ /help/ 302
Expand All @@ -7,8 +7,8 @@ https://help.bump.sh/* https://docs.bump.sh/:splat 301!
/help/publish-documentation/release-management/ /help/publish-documentation/deploy-and-release-management/
/help/branching /help/publish-documentation/branching/
/help/access-management/ /help/publish-documentation/documentation-access-management/
/help/specifications-support/markdown-support/ /help/enhance-documentation-content/markdown-support/
/help/doc-topics/ /help/enhance-documentation-content/topics/
/help/specifications-support/markdown-support/ /help/documentation-experience/markdown-support/
/help/doc-topics/ /help/documentation-experience/topics/
/help/custom-domains/ /help/customization-options/custom-domains/
/help/quick-start/ /help/getting-started/
/help/bump-cli /help/continuous-integration/cli/
Expand Down
Binary file added src/images/help/explorer-auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/help/explorer-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/help/explorer-operation-selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/help/explorer-response.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/help/explorer-share.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1b410c2

Please sign in to comment.