You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ApiRequestSchema.tsx 1.8KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. /*
  2. * SonarQube
  3. * Copyright (C) 2009-2024 SonarSource SA
  4. * mailto:info AT sonarsource DOT com
  5. *
  6. * This program is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 3 of the License, or (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public License
  17. * along with this program; if not, write to the Free Software Foundation,
  18. * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19. */
  20. import { Card, CodeSnippet, TextMuted } from 'design-system';
  21. import { OpenAPIV3 } from 'openapi-types';
  22. import React from 'react';
  23. import { translate } from '../../../helpers/l10n';
  24. import { ExcludeReferences } from '../types';
  25. import { extractSchemaAndMediaType } from '../utils';
  26. interface Props {
  27. content: Exclude<ExcludeReferences<OpenAPIV3.ResponseObject>['content'], undefined>;
  28. }
  29. export default function ApiRequestSchema(props: Readonly<Props>) {
  30. const { content, ...other } = props;
  31. const results = extractSchemaAndMediaType(content);
  32. if (results.length === 0) {
  33. return <TextMuted text={translate('no_data')} />;
  34. }
  35. return results.map(({ requestMediaType, schema }) => (
  36. <Card key={requestMediaType}>
  37. <div>
  38. <span>{translate('api_documentation.v2.request_subheader.request_content_type')}</span>
  39. <CodeSnippet snippet={requestMediaType} isOneLine noCopy />
  40. </div>
  41. <CodeSnippet language="json" className="sw-p-6" snippet={schema} wrap="words" {...other} />
  42. </Card>
  43. ));
  44. }