docs: docs for export OAS from restified endpoint

This PR adds docs for the new console feature to download the OAS from the testified end point.

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9740
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Sean Park-Ross <94021366+seanparkross@users.noreply.github.com>
GitOrigin-RevId: 8a0ea766a5199d1689db330d720312407fa8a5d7
This commit is contained in:
Varun Choudhary 2023-07-06 12:16:36 +05:30 committed by hasura-bot
parent e41be0a2d3
commit d6cb5bff4a
3 changed files with 36 additions and 1 deletions

View File

@ -0,0 +1,35 @@
---
description: Export OpenAPI spec from REST endpoints
sidebar_label: Export OpenAPI Specification
title: 'Export OpenAPI Specification'
keywords:
- hasura
- docs
- RESTified
- REST
- endpoint
sidebar_position: 3
hide_table_of_contents: true
---
import SampleAppBlock from '@site/src/components/SampleAppBlock';
import Thumbnail from '../../src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
import VersionedLink from '@site/src/components/VersionedLink';
# Export OpenAPI Specification
The OpenAPI Specification (OAS) is widely used in REST API development to provide a standardized format for documenting
RESTful APIs.
You can download the OpenAPI 3 specification (OAS 3.0) as a JSON file for all the RESTified GraphQL Endpoints for admin
roles by clicking in the `Export OpenAPI Spec` button from the `REST endpoints` tab from the API section.
<Thumbnail
src="/img/restified/restified-OAS-spec.png"
alt="Create RESTified Endpoint"
width="1000px"
/>
You can also <VersionedLink to="/api-reference/restified/#openapi-3-specification">utilize the API</VersionedLink> to
download the OpenAPI 3 specification

View File

@ -7,7 +7,7 @@ keywords:
- REST
- endpoint
- config
sidebar_position: 3
sidebar_position: 4
toc_max_heading_level: 3
---

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB