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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix api standards link #34

Merged
merged 2 commits into from
Mar 28, 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
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,29 +24,29 @@

Architected to make it easy to get started, whichever way makes sense for you.

[:octicons-arrow-right-24: Jump Into Using The Website](/getting-started/web-application/)
[:octicons-arrow-right-24: Jump Into Using The Website](getting-started/web-application/)

[:octicons-arrow-right-24: Download the Geneweaver CLI](/reference/command-line/)
[:octicons-arrow-right-24: Use The API](reference/api-standards/)

[:octicons-arrow-right-24: Build With Our Python Packages](/reference/available-packages/)
[:octicons-arrow-right-24: Build With Our Python Packages](reference/available-packages/)

- :simple-jupyter:{ .lg .middle } __Example Workflows__

---

Follow real examples of how GeneWeaver's tools will be used to do analysis.

[:octicons-arrow-right-24: NCI-60 Workflow](/tutorial/nci_60_example_01/)
[:octicons-arrow-right-24: NCI-60 Workflow](tutorial/nci_60_example_01/)

[:octicons-arrow-right-24: Authenticating With The Client Library](/tutorial/geneweaver_client_login/)
[:octicons-arrow-right-24: Authenticating With The Client Library](tutorial/geneweaver_client_login/)

- :material-api:{ .lg .middle } __API Standards__

---

Developed to be consistent with our open API Standards.

[:octicons-arrow-right-24: Standards Documentation](/reference/api-standards/)
[:octicons-arrow-right-24: Standards Documentation](reference/api-standards/)

- :material-scale-balance:{ .lg .middle } __Open Source, Apache License 2.0__

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# API Monitoring
> These guiding principles will help stability, uptime, and awareness for your applications.

Actuator endpoints let you monitor and interact with your application. For language
specific tutorials (please see here)[/Development/Tutorials/Monitoring/endpoints].
Actuator endpoints let you monitor and interact with your application.

## Monitoring
Our endpoints for monitoring and info will exist at
Expand All @@ -28,8 +27,8 @@ Example Response:
{"name":"Fancy Application","status":"UP","details":"Everything seems okay."}
````

| Status Text | Http Status Code |
| ----------- | ------------------------------------ |
| `UP` | 200 |
| `UNKNOWN` | 200 |
| `DOWN` | 503 |
| Status Text | Http Status Code |
|--------------|------------------|
| `UP` | 200 |
| `UNKNOWN` | 200 |
| `DOWN` | 503 |
14 changes: 7 additions & 7 deletions docs/reference/api-standards/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ standards for the development of APIs.

The group is focused on exploring the following topics:

* [x] [Standard HTTP Methods & Status Codes](/reference/api-standards/http_standards/)
* [x] [Standard Naming of Endpoints](/reference/api-standards/restful_endpoint_naming/)
* [x] [Standard Naming of Domain Names](/reference/api-standards/dns_naming/)
* [x] Standard structure for response body
* [x] Define Scenarios and Categories of Response Errors
* [x] [Standard for API Versioning and Deprecation](/reference/api-standards/api_versioning/)
* [x] [OpenAPI Schemas](/reference/api-standards/openapi_schemas/) (FKA Swagger)
* [x] [Standard HTTP Methods & Status Codes](http-standards/)
* [x] [Standard Naming of Domain Names](dns-naming/)
* [x] [Standard Naming of Endpoints](restful-endpoint-naming/)
* [x] [Define Scenarios and Categories of Response Errors](error-handling/)
* [x] [OpenAPI Schemas](openapi-schemas/) (FKA Swagger)
* [x] [Standard for API Versioning and Deprecation](api-versioning/)
* [x] [Standard for API Monitoring and Health](api-monitoring/)
* [ ] Testing of all items listed above.
14 changes: 7 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,13 +120,13 @@ nav:
- ReST API: reference/restful-api.md
- API Standards:
- reference/api-standards/index.md
- HTTP Standards: reference/api-standards/http_standards.md
- DNS Naming: reference/api-standards/dns_naming.md
- ReSTful Endpoint Naming: reference/api-standards/restful_endpoint_naming.md
- OpenAPI Schemas: reference/api-standards/openapi_schemas.md
- API Versioning: reference/api-standards/api_versioning.md
- API Monitoring: reference/api-standards/api_monitoring.md
- Response Errors: reference/api-standards/error_handling.md
- HTTP Standards: reference/api-standards/http-standards.md
- DNS Naming: reference/api-standards/dns-naming.md
- ReSTful Endpoint Naming: reference/api-standards/restful-endpoint-naming.md
- Response Errors: reference/api-standards/error-handling.md
- OpenAPI Schemas: reference/api-standards/openapi-schemas.md
- API Versioning: reference/api-standards/api-versioning.md
- API Monitoring: reference/api-standards/api-monitoring.md
- Available Packages: reference/available-packages.md
- Available Tools: reference/available-tools.md
# - Scientific Workflows: reference/scientific-workflows.md
Expand Down
Loading