Skip to content

Commit 8db776e

Browse files
md file
1 parent 59ca5d3 commit 8db776e

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

dev-docs/context-docs-VS Code Commands-_Modify-Yaml-API-Documentation-Command.md.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,21 @@ To use:
3737

3838
This command streamlines API documentation maintenance, saving time and ensuring consistency with the API specification.
3939

40+
41+
---
42+
# Example JSON of Relevant `dev-docs.json` Options docs/VS Code Commands/_Modify-Yaml-API-Documentation-Command.md
43+
## Imported Code Object
44+
Certainly! This JSON snippet represents configuration options for a development documentation system. Here's a concise explanation:
45+
46+
1. The outer object contains an "ai" key, suggesting AI-related settings.
47+
48+
2. Within "ai", there's an "openapi" object, which likely refers to OpenAPI (formerly Swagger) configuration.
49+
50+
3. The "file" key specifies the location of the OpenAPI specification file: "src/api/openapi.yaml".
51+
52+
4. The "x-codeSamples" object is a custom extension (indicated by the "x-" prefix) for code samples:
53+
- "langs" array lists programming languages for which code samples should be generated: JavaScript, Python, and Ruby.
54+
55+
This configuration would be used to generate API documentation with code samples in the specified languages based on the OpenAPI specification file.
56+
4057

0 commit comments

Comments
 (0)