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

Add x-typespec-generated to openapi3 emitter #5729

Open
3 tasks done
mikeharder opened this issue Jan 24, 2025 · 1 comment
Open
3 tasks done

Add x-typespec-generated to openapi3 emitter #5729

mikeharder opened this issue Jan 24, 2025 · 1 comment
Labels
emitter:openapi3 Issues for @typespec/openapi3 emitter

Comments

@mikeharder
Copy link
Contributor

Clear and concise description of the problem

The typespec-autorest emitter includes the marker x-typespec-generated in the output:

{
  "swagger": "2.0",
  "info": {
    "title": "(title)",
    "version": "0000-00-00",
    "x-typespec-generated": [
      {
        "emitter": "@azure-tools/typespec-autorest"
      }
    ]
  },

For consistency, I think the openapi3 emitter should also output a marker. Currently, it does not:

openapi: 3.0.0
info:
  title: (title)
  version: 0.0.0
tags: []
paths: {}
components: {}

Checklist

  • Follow our Code of Conduct
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@lirenhe lirenhe added the emitter:openapi3 Issues for @typespec/openapi3 emitter label Jan 26, 2025
@wanlwanl
Copy link
Member

Hi @mikeharder, could you share the scenario that uses x-typespec-generated?
@timotheeguerin, what do you think about it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
emitter:openapi3 Issues for @typespec/openapi3 emitter
Projects
None yet
Development

No branches or pull requests

3 participants