Skip to content

chore: move and extend AsyncAPI docs - #2819

Open
swaldmann wants to merge 7 commits into
mainfrom
asyncapi-mv
Open

chore: move and extend AsyncAPI docs#2819
swaldmann wants to merge 7 commits into
mainfrom
asyncapi-mv

Conversation

@swaldmann

@swaldmann swaldmann commented Aug 13, 2026

Copy link
Copy Markdown
Contributor
  • documented cds import --asyncapi usage
  • added programmatic usage (currently only documented in plugin README, which now links here, see chore: update README to point to AsyncAPI guide cap-js/asyncapi#55)
  • added link to cds.import.from.asyncapi guide in design time CLIs (tbd if we should move this to central AsyncAPI guide)
  • moved the cds.compile.to.asyncapi documentation to AsyncAPI guide
  • fixed some (imo) suboptimal formatting in .cds samples

Comment thread tools/apis/cds-import.md
[Learn more about OpenAPI to OData Mapping.](#openapi-to-cds-odata-csn-conversion-mapping){.learn-more}

## cds.import.from.asyncapi() {.method}
## cds.import.from.asyncapi() {.method #from-asyncapi}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reads nicer: cap.cloud.sap/docs/tools/apis/cds-import#from-asyncapi

@swaldmann
swaldmann requested review from chgeo and daogrady August 14, 2026 08:54
@swaldmann
swaldmann marked this pull request as ready for review August 14, 2026 08:54
Use `cds import` to convert an AsyncAPI document into a CDS service definition:

```sh
cds import --asyncapi ~/Downloads/BookStore_AsyncAPI.json

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this made me realise that we have this weird pairing of cds compile + cds import to do one roundtrip, whereas cds export is also a thing. :/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants