Skip to content
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.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cloud docs API Reference #760

Merged
merged 1 commit into from
Apr 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/griptape-cloud/api/api-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Content overriden by Swagger Plugin
3 changes: 3 additions & 0 deletions docs/griptape-cloud/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Griptape Cloud

Griptape Cloud is a managed platform for running AI-powered agents, pipelines, and workflows.
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ Welcome to Griptape Docs! This documentation is organized into the following sec

Griptape Topic Guides discuss key topics at a high level and provide useful background information and explanation.

### Griptape Cloud

[Griptape Cloud](griptape-cloud/api/api-reference.md) provides an overview of the APIs available in the managed cloud service.

### Griptape Framework

[Griptape Framework](griptape-framework/index.md) provides an overview of the key topics within Griptape, and how you can get started building agents.
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/swagger_ui_plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from markupsafe import Markup

config_scheme = {
"spec_url": "https://cloud-preview.griptape.ai/public/openapi.yaml",
"spec_url": "https://griptape-cloud-assets.s3.amazonaws.com/Griptape.openapi.yaml",
"template": "swagger.md.tmpl",
"outfile": "griptape-cloud/api/api-reference.md",
}
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ nav:
- Home:
- Overview: "index.md"
- Contributing: "contributing.md"
- Cloud:
- Cloud API:
- API Reference: "griptape-cloud/api/api-reference.md"
- Framework:
- Overview: "griptape-framework/index.md"
- Structures:
Expand Down
Loading