Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into issue-862
Browse files Browse the repository at this point in the history
AayushSaini101 authored Dec 31, 2024
2 parents e8dee38 + 492119c commit d5bbd16
Showing 13 changed files with 2,978 additions and 3,029 deletions.
5 changes: 0 additions & 5 deletions .changeset/red-paws-ring.md

This file was deleted.

7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# @asyncapi/cli

## 2.14.1

### Patch Changes

- 08afb45: Prepare github action for release
- da64c63: ci: bump artifact actions to v4

## 2.14.0

### Minor Changes
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -38,7 +38,7 @@ runs:
using: 'docker'
# This is the image that will be used to run the action.
# IMPORTANT: The version has to be changed manually in your PRs.
image: 'docker://asyncapi/github-action-for-cli:2.14.0'
image: 'docker://asyncapi/github-action-for-cli:2.14.1'
args:
- ${{ inputs.cli_version }}
- ${{ inputs.command }}
60 changes: 30 additions & 30 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@ $ npm install -g @asyncapi/cli
$ asyncapi COMMAND
running command...
$ asyncapi (--version)
@asyncapi/cli/2.12.0 linux-x64 node-v18.20.5
@asyncapi/cli/2.14.1 linux-x64 node-v18.20.5
$ asyncapi --help [COMMAND]
USAGE
$ asyncapi COMMAND
@@ -101,7 +101,7 @@ EXAMPLES
$ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service
```

_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/bundle.ts)_
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/bundle.ts)_

## `asyncapi config`

@@ -115,7 +115,7 @@ DESCRIPTION
CLI config settings
```

_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/index.ts)_
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/index.ts)_

## `asyncapi config analytics`

@@ -135,7 +135,7 @@ DESCRIPTION
Enable or disable analytics for metrics collection
```

_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/analytics.ts)_
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/analytics.ts)_

## `asyncapi config context`

@@ -149,7 +149,7 @@ DESCRIPTION
Manage short aliases for full paths to AsyncAPI documents
```

_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/index.ts)_
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/index.ts)_

## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`

@@ -171,7 +171,7 @@ DESCRIPTION
Add a context to the store
```

_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/add.ts)_
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/add.ts)_

## `asyncapi config context current`

@@ -188,7 +188,7 @@ DESCRIPTION
Shows the current context that is being used
```

_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/current.ts)_
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/current.ts)_

## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`

@@ -209,7 +209,7 @@ DESCRIPTION
Edit a context in the store
```

_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/edit.ts)_
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/edit.ts)_

## `asyncapi config context init [CONTEXT-FILE-PATH]`

@@ -232,7 +232,7 @@ DESCRIPTION
Initialize context
```

_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/init.ts)_
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/init.ts)_

## `asyncapi config context list`

@@ -249,7 +249,7 @@ DESCRIPTION
List all the stored contexts in the store
```

_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/list.ts)_
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/list.ts)_

## `asyncapi config context remove CONTEXT-NAME`

@@ -269,7 +269,7 @@ DESCRIPTION
Delete a context from the store
```

_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/remove.ts)_
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/remove.ts)_

## `asyncapi config context use CONTEXT-NAME`

@@ -289,7 +289,7 @@ DESCRIPTION
Set a context as current
```

_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/context/use.ts)_
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/context/use.ts)_

## `asyncapi config versions`

@@ -306,7 +306,7 @@ DESCRIPTION
Show versions of AsyncAPI tools used
```

_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/config/versions.ts)_
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/versions.ts)_

## `asyncapi convert [SPEC-FILE]`

@@ -334,7 +334,7 @@ DESCRIPTION
Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI
```

_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/convert.ts)_
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/convert.ts)_

## `asyncapi diff OLD NEW`

@@ -375,7 +375,7 @@ DESCRIPTION
Find diff between two asyncapi files
```

_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/diff.ts)_
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/diff.ts)_

## `asyncapi format [SPEC-FILE]`

@@ -398,7 +398,7 @@ DESCRIPTION
Convert asyncapi documents from any format to yaml, yml or JSON
```

_See code: [src/commands/format.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/format.ts)_
_See code: [src/commands/format.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/format.ts)_

## `asyncapi generate`

@@ -412,7 +412,7 @@ DESCRIPTION
Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
```

_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/generate/index.ts)_
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/generate/index.ts)_

## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`

@@ -457,7 +457,7 @@ EXAMPLES
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
```

_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/generate/fromTemplate.ts)_
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/generate/fromTemplate.ts)_

## `asyncapi generate models LANGUAGE FILE`

@@ -527,7 +527,7 @@ DESCRIPTION
Generates typed models
```

_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/generate/models.ts)_
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/generate/models.ts)_

## `asyncapi new`

@@ -585,7 +585,7 @@ EXAMPLES
$ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode
```

_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/new/index.ts)_
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/index.ts)_

## `asyncapi new file`

@@ -643,7 +643,7 @@ EXAMPLES
$ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode
```

_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/new/file.ts)_
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/file.ts)_

## `asyncapi new glee`

@@ -665,7 +665,7 @@ DESCRIPTION
Creates a new Glee project
```

_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/new/glee.ts)_
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/glee.ts)_

## `asyncapi new template`

@@ -689,7 +689,7 @@ DESCRIPTION
Creates a new template
```

_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/new/template.ts)_
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/template.ts)_

## `asyncapi optimize [SPEC-FILE]`

@@ -731,11 +731,11 @@ EXAMPLES
$ asyncapi optimize ./asyncapi.yaml --ignore=schema
```

_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/optimize.ts)_
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/optimize.ts)_

## `asyncapi pretty SPEC-FILE`

Format AsyncAPI specification file
Beautify the AsyncAPI spec file (indentation, styling) in place or output the formatted spec to a new file.

```
USAGE
@@ -748,15 +748,15 @@ FLAGS
-o, --output=<value> Output file path
DESCRIPTION
Format AsyncAPI specification file
Beautify the AsyncAPI spec file (indentation, styling) in place or output the formatted spec to a new file.
EXAMPLES
$ asyncapi pretty ./asyncapi.yaml
$ asyncapi pretty ./asyncapi.yaml --output formatted-asyncapi.yaml
```

_See code: [src/commands/pretty.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/pretty.ts)_
_See code: [src/commands/pretty.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/pretty.ts)_

## `asyncapi start`

@@ -770,7 +770,7 @@ DESCRIPTION
Starts AsyncAPI-related services. Currently, it supports launching the AsyncAPI Studio
```

_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/start/index.ts)_
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/start/index.ts)_

## `asyncapi start studio`

@@ -789,7 +789,7 @@ DESCRIPTION
starts a new local instance of Studio
```

_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/start/studio.ts)_
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/start/studio.ts)_

## `asyncapi validate [SPEC-FILE]`

@@ -820,5 +820,5 @@ DESCRIPTION
validate asyncapi file
```

_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.12.0/src/commands/validate.ts)_
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/validate.ts)_
<!-- commandsstop -->
73 changes: 73 additions & 0 deletions github-action/test/unoptimized_optimized.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
asyncapi: 2.0.0
info:
title: Streetlights API
version: 1.0.0
channels:
smartylighting/event/{streetlightId}/lighting/measured:
$ref: >-
#/components/channels/smartylighting/event/{streetlightId}/lighting/measured
parameters:
streetlightId:
schema:
$ref: '#/components/schemas/schema'
smartylighting/action/{streetlightId}/turn/on:
$ref: '#/components/channels/smartylighting/action/{streetlightId}/turn/on'
components:
schemas:
sentAt:
type: string
format: date-time
lumens:
type: integer
minimum: 0
payload:
type: object
properties:
sentAt:
$ref: '#/components/schemas/sentAt'
messages:
message:
name: turnOnOff
title: Turn on/off
traits:
- headers:
type: object
properties:
my-app-header:
type: integer
minimum: 0
maximum: 100
payload:
$ref: '#/components/schemas/payload'
operations:
subscribe:
operationId: receiveLightMeasurement
traits:
- bindings:
kafka:
clientId: my-app-id
message:
$ref: '#/components/messages/message'
publish:
operationId: turnOn
traits:
- bindings:
kafka:
clientId: my-app-id
message:
$ref: '#/components/messages/message'
channels:
smartylighting/event/{streetlightId}/lighting/measured:
parameters:
streetlightId:
schema:
$ref: '#/components/schemas/schema'
subscribe:
$ref: '#/components/operations/subscribe'
smartylighting/action/{streetlightId}/turn/on:
parameters:
streetlightId:
schema:
$ref: '#/components/schemas/schema'
publish:
$ref: '#/components/operations/publish'
Loading

0 comments on commit d5bbd16

Please sign in to comment.