Skip to content

fix: allow Send API Request button with proxy-only configuration #1274

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.

Sign up for GitHub

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

Open
emmanuel-ferdman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: allow Send API Request button with proxy-only configuration #1274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Request/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import React, { useState } from "react";
import { useDoc } from "@docusaurus/plugin-content-docs/client";
import { translate } from "@docusaurus/Translate";
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
import type { ThemeConfig } from "docusaurus-theme-openapi-docs/src/types";
import Accept from "@theme/ApiExplorer/Accept";
import Authorization from "@theme/ApiExplorer/Authorization";
import Body from "@theme/ApiExplorer/Body";
Expand All @@ -30,6 +29,7 @@ import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
import { OPENAPI_REQUEST } from "@theme/translationIds";
import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
import type { ThemeConfig } from "docusaurus-theme-openapi-docs/src/types";
import * as sdk from "postman-collection";
import { FormProvider, useForm } from "react-hook-form";

Expand Down Expand Up @@ -200,7 +200,7 @@ function Request({ item }: { item: ApiItem }) {
const showServerOptions = serverOptions.length > 0;
const showAcceptOptions = acceptOptions.length > 1;
const showRequestBody = contentType !== undefined;
const showRequestButton = item.servers && !hideSendButton;
const showRequestButton = (item.servers || proxy) && !hideSendButton;
const showAuth = authSelected !== undefined;
const showParams = allParams.length > 0;
const requestBodyRequired = item.requestBody?.required;
Expand All @@ -210,7 +210,8 @@ function Request({ item }: { item: ApiItem }) {
!showAuth &&
!showParams &&
!showRequestBody &&
!showServerOptions
!showServerOptions &&
!showRequestButton
) {
return null;
}
Expand Down
8 changes: 7 additions & 1 deletion packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Response/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ import React from "react";
import { useDoc } from "@docusaurus/plugin-content-docs/client";
import { usePrismTheme } from "@docusaurus/theme-common";
import { translate } from "@docusaurus/Translate";
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
import ApiCodeBlock from "@theme/ApiExplorer/ApiCodeBlock";
import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import { OPENAPI_RESPONSE } from "@theme/translationIds";
import clsx from "clsx";
import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
import type { ThemeConfig } from "docusaurus-theme-openapi-docs/src/types";

import { clearResponse, clearCode, clearHeaders } from "./slice";

Expand All @@ -42,7 +44,11 @@ function formatXml(xml: string) {

function Response({ item }: { item: ApiItem }) {
const metadata = useDoc();
const { siteConfig } = useDocusaurusContext();
const themeConfig = siteConfig.themeConfig as ThemeConfig;
const hideSendButton = metadata.frontMatter.hide_send_button;
const proxy =
metadata.frontMatter.proxy ?? themeConfig.api?.proxy;
const prismTheme = usePrismTheme();
const code = useTypedSelector((state: any) => state.response.code);
const headers = useTypedSelector((state: any) => state.response.headers);
Expand All @@ -57,7 +63,7 @@ function Response({ item }: { item: ApiItem }) {
? "openapi-response__dot--success"
: "openapi-response__dot--info");

if (!item.servers || hideSendButton) {
if ((!item.servers && !proxy) || hideSendButton) {
return null;
}

Expand Down