bruno icon indicating copy to clipboard operation
bruno copied to clipboard

OpenAPI Designer should export the available endpoints

Open Zer0x00 opened this issue 1 year ago • 6 comments
trafficstars

The "Create API Spec" button creates right now an empty file where you can type hand-written yaml content.

Since OpenAPI Designer is a feature which is advertised for the Golden Edition I thought that it would be the case that the created requests would be exported to the OpenAPI spec - in fact, this feature was one of the reasons I switched to bruno in the first place.

After updating to the latest version and activating my license, I was disappointed to see only a blank form.

The buy page should make clear that the feature is right now not more useful than any SwaggerUI instance or any Swagger online editor. I don't know what was meant with "OpenAPI Designer" but if it was not the auto-generation of OpenAPI specs this issue could be seen as a feature request for it.

Zer0x00 avatar Mar 20 '24 21:03 Zer0x00

@Zer0x00 I'm basically in the issues because of this too.

I bought the Golden License for this and all I see is a form, it is not even showing a preview on my end.

devhammed avatar Mar 20 '24 21:03 devhammed

@Zer0x00 I'm basically in the issues because of this too.

I bought the Golden License for this and all I see is a form, it is not even showing a preview on my end.

If you type in an example OpenAPI yaml (like the one from the above linked editor) and save it, you should see the same SwaggerUI on the right side of the UI. Without saving it you won't see anything.

Should look like this: image

Zer0x00 avatar Mar 20 '24 21:03 Zer0x00

@Zer0x00 I'm basically in the issues because of this too. I bought the Golden License for this and all I see is a form, it is not even showing a preview on my end.

If you type in an example OpenAPI yaml (like the one from the above linked editor) and save it, you should see the same SwaggerUI on the right side of the UI. Without saving it you won't see anything.

Should look like this: image

I saved it but still couldn't see anything.

devhammed avatar Mar 20 '24 22:03 devhammed

This is happening to me too, with a file that worked yesterday. Today I don't see anything on the right. Edit to add, I'm on a Mac, latest version of MacOS, using Bruno 1.12.1, purchased a golden license.

What I see image

With this yaml

info:
  title: Simple API overview
  version: 2.0.0
paths:
  /:
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        '200':
          description: |-
            200 response
          content:
            application/json:
              examples: 
                foo:
                  value:
                    {
                      "versions": [
                        {
                            "status": "CURRENT",
                            "updated": "2011-01-21T11:33:21Z",
                            "id": "v2.0",
                            "links": [
                                {
                                    "href": "http://127.0.0.1:8774/v2/",
                                    "rel": "self"
                                }
                            ]
                        },
                        {
                            "status": "EXPERIMENTAL",
                            "updated": "2013-07-23T11:33:21Z",
                            "id": "v3.0",
                            "links": [
                                {
                                    "href": "http://127.0.0.1:8774/v3/",
                                    "rel": "self"
                                }
                            ]
                        }
                      ]
                    }
        '300':
          description: |-
            300 response
          content:
            application/json: 
              examples: 
                foo:
                  value: |
                   {
                    "versions": [
                          {
                            "status": "CURRENT",
                            "updated": "2011-01-21T11:33:21Z",
                            "id": "v2.0",
                            "links": [
                                {
                                    "href": "http://127.0.0.1:8774/v2/",
                                    "rel": "self"
                                }
                            ]
                        },
                        {
                            "status": "EXPERIMENTAL",
                            "updated": "2013-07-23T11:33:21Z",
                            "id": "v3.0",
                            "links": [
                                {
                                    "href": "http://127.0.0.1:8774/v3/",
                                    "rel": "self"
                                }
                            ]
                        }
                    ]
                   }
  /v2:
    get:
      operationId: getVersionDetailsv2
      summary: Show API version details
      responses:
        '200':
          description: |-
            200 response
          content:
            application/json: 
              examples:
                foo:
                  value:
                    {
                      "version": {
                        "status": "CURRENT",
                        "updated": "2011-01-21T11:33:21Z",
                        "media-types": [
                          {
                              "base": "application/xml",
                              "type": "application/vnd.openstack.compute+xml;version=2"
                          },
                          {
                              "base": "application/json",
                              "type": "application/vnd.openstack.compute+json;version=2"
                          }
                        ],
                        "id": "v2.0",
                        "links": [
                          {
                              "href": "http://127.0.0.1:8774/v2/",
                              "rel": "self"
                          },
                          {
                              "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
                              "type": "application/pdf",
                              "rel": "describedby"
                          },
                          {
                              "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
                              "type": "application/vnd.sun.wadl+xml",
                              "rel": "describedby"
                          },
                          {
                            "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
                            "type": "application/vnd.sun.wadl+xml",
                            "rel": "describedby"
                          }
                        ]
                      }
                    }
        '203':
          description: |-
            203 response
          content:
            application/json: 
              examples:
                foo:
                  value:
                    {
                      "version": {
                        "status": "CURRENT",
                        "updated": "2011-01-21T11:33:21Z",
                        "media-types": [
                          {
                              "base": "application/xml",
                              "type": "application/vnd.openstack.compute+xml;version=2"
                          },
                          {
                              "base": "application/json",
                              "type": "application/vnd.openstack.compute+json;version=2"
                          }
                        ],
                        "id": "v2.0",
                        "links": [
                          {
                              "href": "http://23.253.228.211:8774/v2/",
                              "rel": "self"
                          },
                          {
                              "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
                              "type": "application/pdf",
                              "rel": "describedby"
                          },
                          {
                              "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
                              "type": "application/vnd.sun.wadl+xml",
                              "rel": "describedby"
                          }
                        ]
                      }
                    }

Wintaru avatar Mar 21 '24 11:03 Wintaru

@Wintaru You are missing openapi: 3.1.0 (or any other version for that matter) on the first line.

But I expect you to have the same problem like @devhammed since it shows me this error message on the right side: image

Zer0x00 avatar Mar 21 '24 13:03 Zer0x00

@Wintaru You are missing openapi: 3.1.0 (or any other version for that matter) on the first line.

But I expect you to have the same problem like @devhammed since it shows me this error message on the right side: image

Sorry I didn't realize your issue wasn't related, I didn't mean to hijack your thread. However if you look at my original photo, the openapi tag is on the first line in the screenshot, I must not have copied it when I tried to copy the yaml over. Either way sorry about putting this here, it's distracting from your original thread intent.

Wintaru avatar Mar 21 '24 13:03 Wintaru