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

Api definition guidelines #71

Closed
Closed
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
914fa3c
ApiDefinitionGuidelines: Add README section for API Definitions
gabe-l-hart May 31, 2024
0181d0d
ApiDefinitionGuidelines: Add stub of api-definitions directory
gabe-l-hart May 31, 2024
b02d87a
ApiDefinitionGuidelines: Add api-definitions-guidelines doc
gabe-l-hart May 31, 2024
88256c0
ApiDefinitionGuidelines: Fix spellcheck errors
gabe-l-hart May 31, 2024
dee4d60
ApiDefinitionGuidelines: Add section on API versioning
gabe-l-hart Jun 4, 2024
f32fbc5
ApiDefinitionGuidelines: Move API definitions under docs/backend
gabe-l-hart Jun 6, 2024
570697c
ApiDefinitionGuidelines: Expand on the casing guidelines
gabe-l-hart Jun 7, 2024
18cdcf1
ApiDefinitionGuidelines: Adjust proposal to place API specs in a new …
gabe-l-hart Jun 10, 2024
02b5a19
Improvements in language for OpenAPI
gabe-l-hart Jun 11, 2024
20fb26e
ApiDefinitionGuidelines: Remove mention of api-definitions in this repo
gabe-l-hart Jun 11, 2024
aba535b
ApiDefinitionGuidelines: Remove reference to local api-definitions dir
gabe-l-hart Jun 11, 2024
f67ffff
ApiDefinitionGuidelines: update service-api-definitions -> openapi fo…
gabe-l-hart Jun 12, 2024
a90d70b
ApiDefinitionGuidelines: Remove third option for consuming APIs by copy
gabe-l-hart Jun 12, 2024
e486715
Update docs/backend/api-definitions-guidelines.md
gabe-l-hart Jun 24, 2024
39579d0
Merge branch 'main' into ApiDefinitionGuidelines
hickeyma Jul 2, 2024
12ae3a0
Typo fix in api definitions guidelines
gabe-l-hart Jul 2, 2024
5aff3e2
Wording improvements from review
gabe-l-hart Jul 2, 2024
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
Prev Previous commit
Next Next commit
ApiDefinitionGuidelines: Move API definitions under docs/backend
Signed-off-by: Gabe Goodhart <[email protected]>
gabe-l-hart committed Jun 11, 2024
commit f32fbc59a31e7afac6231532687162ffcd8e5adb
Original file line number Diff line number Diff line change
@@ -13,8 +13,8 @@ The `InstructLab APIs` are essential for hosting `InstructLab` as a service in a

## How will service APIs be defined?

Service APIs will be defined using [OpenAPI](https://www.openapis.org/) format in [YAML](https://yaml.org/). For structural and style guidelines, see [api-definitions](../api-definitions/README.md).
Service APIs will be defined using [OpenAPI](https://www.openapis.org/) format in [YAML](https://yaml.org/). For structural and style guidelines, see [api-definitions](../../api-definitions/README.md).

## Where will service API definitions live?

Service API definitions will live in [api-definitions](../api-definitions) within this repo.
Service API definitions will live in [api-definitions](../../api-definitions) within this repo.