initial commit after project creation
This commit is contained in:
8
content/docs/api-documentation/overview.mdx
Normal file
8
content/docs/api-documentation/overview.mdx
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Overview
|
||||
last_edited: '2025-07-15T07:33:40.077Z'
|
||||
---
|
||||
|
||||
TinaDocs supports documenting your API directly from an OpenAPI .json specification (OAS). This allows you to generate structured, editable documentation blocks that reflect real API endpoints—without manually copying and pasting details.
|
||||
|
||||
This tab has been used to provide some miscellaneous example documentation, based on an OAS.
|
||||
23
content/docs/api-documentation/pet/get-pet-findbystatus.mdx
Normal file
23
content/docs/api-documentation/pet/get-pet-findbystatus.mdx
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
description: Multiple status values can be provided with comma separated strings
|
||||
seo:
|
||||
title: Finds Pets by Status
|
||||
description: Multiple status values can be provided with comma separated strings
|
||||
title: Finds Pets by Status
|
||||
last_edited: '2025-07-15T07:40:42.267Z'
|
||||
auto_generated: true
|
||||
---
|
||||
|
||||
Multiple status values can be provided with comma separated strings
|
||||
|
||||
## Endpoint Details
|
||||
|
||||
**Method:** `GET`
|
||||
|
||||
|
||||
|
||||
**Path:** `/pet/findByStatus`
|
||||
|
||||
## API Reference
|
||||
|
||||
<apiReference schemaFile="Swagger-Petstore.json|GET:/pet/findByStatus" />
|
||||
27
content/docs/api-documentation/pet/get-pet-findbytags.mdx
Normal file
27
content/docs/api-documentation/pet/get-pet-findbytags.mdx
Normal file
@@ -0,0 +1,27 @@
|
||||
---
|
||||
description: >-
|
||||
Multiple tags can be provided with comma separated strings. Use tag1, tag2,
|
||||
tag3 for testing.
|
||||
seo:
|
||||
title: Finds Pets by Tags
|
||||
description: >-
|
||||
Multiple tags can be provided with comma separated strings. Use tag1, tag2,
|
||||
tag3 for testing.
|
||||
title: Finds Pets by Tags
|
||||
last_edited: '2025-07-15T07:40:41.760Z'
|
||||
auto_generated: true
|
||||
---
|
||||
|
||||
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
## Endpoint Details
|
||||
|
||||
**Method:** `GET`
|
||||
|
||||
|
||||
|
||||
**Path:** `/pet/findByTags`
|
||||
|
||||
## API Reference
|
||||
|
||||
<apiReference schemaFile="Swagger-Petstore.json|GET:/pet/findByTags" />
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
description: 'API endpoint for POST /pet/{petId}/uploadImage'
|
||||
seo:
|
||||
title: Uploads an Image
|
||||
description: 'API endpoint for POST /pet/{petId}/uploadImage'
|
||||
title: Uploads an Image
|
||||
last_edited: '2025-07-15T07:40:41.566Z'
|
||||
auto_generated: true
|
||||
---
|
||||
|
||||
## Endpoint Details
|
||||
|
||||
**Method:** `POST`
|
||||
|
||||
|
||||
|
||||
**Path:** `/pet/{petId}/uploadImage`
|
||||
|
||||
## API Reference
|
||||
|
||||
<apiReference schemaFile="Swagger-Petstore.json|POST:/pet/{petId}/uploadImage" />
|
||||
21
content/docs/api-documentation/pet/post-pet-petid.mdx
Normal file
21
content/docs/api-documentation/pet/post-pet-petid.mdx
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
description: 'API endpoint for POST /pet/{petId}'
|
||||
seo:
|
||||
title: Updates a Pet in the Store with Form Data
|
||||
description: 'API endpoint for POST /pet/{petId}'
|
||||
title: Updates a Pet in the Store with Form Data
|
||||
last_edited: '2025-07-15T07:40:41.851Z'
|
||||
auto_generated: true
|
||||
---
|
||||
|
||||
## Endpoint Details
|
||||
|
||||
**Method:** `POST`
|
||||
|
||||
|
||||
|
||||
**Path:** `/pet/{petId}`
|
||||
|
||||
## API Reference
|
||||
|
||||
<apiReference schemaFile="Swagger-Petstore.json|POST:/pet/{petId}" />
|
||||
21
content/docs/api-documentation/pet/post-pet.mdx
Normal file
21
content/docs/api-documentation/pet/post-pet.mdx
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
description: API endpoint for POST /pet
|
||||
seo:
|
||||
title: Add a New Pet to the Store
|
||||
description: API endpoint for POST /pet
|
||||
title: Add a New Pet to the Store
|
||||
last_edited: '2025-07-15T07:40:42.182Z'
|
||||
auto_generated: true
|
||||
---
|
||||
|
||||
## Endpoint Details
|
||||
|
||||
**Method:** `POST`
|
||||
|
||||
|
||||
|
||||
**Path:** `/pet`
|
||||
|
||||
## API Reference
|
||||
|
||||
<apiReference schemaFile="Swagger-Petstore.json|POST:/pet" />
|
||||
21
content/docs/api-documentation/pet/put-pet.mdx
Normal file
21
content/docs/api-documentation/pet/put-pet.mdx
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
description: API endpoint for PUT /pet
|
||||
seo:
|
||||
title: Update an Existing Pet
|
||||
description: API endpoint for PUT /pet
|
||||
title: Update an Existing Pet
|
||||
last_edited: '2025-07-15T07:40:41.710Z'
|
||||
auto_generated: true
|
||||
---
|
||||
|
||||
## Endpoint Details
|
||||
|
||||
**Method:** `PUT`
|
||||
|
||||
|
||||
|
||||
**Path:** `/pet`
|
||||
|
||||
## API Reference
|
||||
|
||||
<apiReference schemaFile="Swagger-Petstore.json|PUT:/pet" />
|
||||
20
content/docs/api-documentation/user/get-user-logout.mdx
Normal file
20
content/docs/api-documentation/user/get-user-logout.mdx
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
seo:
|
||||
title: Logs Out Current Logged in User Session
|
||||
description: API endpoint for GET /user/logout
|
||||
title: Logs Out Current Logged in User Session
|
||||
last_edited: '2025-07-15T07:40:41.523Z'
|
||||
auto_generated: true
|
||||
---
|
||||
|
||||
## Endpoint Details
|
||||
|
||||
**Method:** `GET`
|
||||
|
||||
|
||||
|
||||
**Path:** `/user/logout`
|
||||
|
||||
## API Reference
|
||||
|
||||
<apiReference schemaFile="Swagger-Petstore.json|GET:/user/logout" />
|
||||
22
content/docs/api-documentation/user/post-user.mdx
Normal file
22
content/docs/api-documentation/user/post-user.mdx
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
seo:
|
||||
title: Create User
|
||||
description: This can only be done by the logged in user.
|
||||
title: Create User
|
||||
last_edited: '2025-07-15T07:40:41.468Z'
|
||||
auto_generated: true
|
||||
---
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
## Endpoint Details
|
||||
|
||||
**Method:** `POST`
|
||||
|
||||
|
||||
|
||||
**Path:** `/user`
|
||||
|
||||
## API Reference
|
||||
|
||||
<apiReference schemaFile="Swagger-Petstore.json|POST:/user" />
|
||||
Reference in New Issue
Block a user