Skip to content

Commit

Permalink
Merge pull request #229 from microsoft/junhan/august-release
Browse files Browse the repository at this point in the history
docs: add changelog and readme for August release
  • Loading branch information
sthirthala authored Aug 13, 2024
2 parents 693d6a9 + eaf0ba7 commit a6f8a4e
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 2 deletions.
12 changes: 12 additions & 0 deletions PRERELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@

> Note: This changelog only includes the changes for the pre-release versions of Azure API Center for Visual Studio Code. For the changelog of stable versions, please refer to the [Changelog of Azure API Center for Visual Studio Code](https://github.com/microsoft/vscode-azureapicenter/blob/main/CHANGELOG.md).
### August 14, 2024

* Manage API Analysis for Azure API Center:
* Enable API Analysis
* View and edit linting rules
* Create, rename and delete JavaScript Custom Functions
* Live linting for OpenAPI documentation to test linting rules
* Sync linting rules to local
* Deploy linting rules to Azure API Center
* Generating Open API specification from an API code: use `gpt-4o` model to increase performance.
* Set active API Style Guide: support to select active file.

### July 16, 2024

* Generating Markdown documentation for an API: We have added a new command in the tree view of API definition called "Generate Markdown" to allow developers to easily generate markdown documentation.
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,15 @@ Shift-left API design conformance checks into Visual Studio Code with integrated

![linting](./media/integrated-lint.png)

[[Pre-Release]](#pre-release) Manage API Analysis for Azure API Center.

![Manage API Analysis](./media/managed-lint.png)

Ensure that new API versions don't break API consumers with breaking change detection support, powered by Optic.

![Breaking Change Detection](./media/breaking-change.png)

[pre-release] Generate Open API specification file from API code.
[[Pre-Release]](#pre-release) Generate Open API specification file from API code.

![Generate Open API specification](./media/generate-api-documentation.gif)

Expand All @@ -39,7 +43,7 @@ Explore API requests and responses with automated .http file generation powered

![generate-http-file](./media/generate-http-file.png)

[pre-release] Generate markdown documentation for an API definition.
[[Pre-Release]](#pre-release) Generate markdown documentation for an API definition.

![Generate Markdown](./media/generate-markdown.png)

Expand All @@ -53,7 +57,11 @@ Export API specification document for a specific API either from the tree view o

![Export API specification](./media/export-api.gif)

## Pre-Release

For the features with `[Pre-Release]` flag, you need to install pre-release version of the extension.

![](/media/pre-release.png)

## Contributing

Expand Down
Binary file added media/managed-lint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/pre-release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a6f8a4e

Please sign in to comment.