stoplightio / elements

Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.
https://stoplight.io/open-source/elements/
Apache License 2.0
1.61k stars 189 forks source link

Missing content OpenID security scheme #2271

Open shoffmeister opened 1 year ago

shoffmeister commented 1 year ago

Given an API with an OpenID Connect security scheme, the details of that security scheme - the openIdConnectUrl - are not rendered.

Context

Security scheme details are not visible; only "empty space" is visible. This leads to irritation at the very least.

Current Behavior

No content rendered for OpenID Connect security scheme

Expected Behavior

Content should be rendered for the OpenID Connect security scheme, specifically the openIdConnectUrl.

The output should match stylistically what is already happening for oauth2 flows.

Possible Workaround/Solution

none

Steps to Reproduce

Render

---
  openapi: 3.0.3
  info:
    description: info description
    contact:
     email: info.contact.email@example.com
     name: info contact name
     url: http://info.url
    license:
      name: info license name
      url: http://info.license.url/
    title: info title
    version: 1.2.3

  servers:
    - url: http://localhost:8080

  components:
    securitySchemes:
      my_openid_connect_number1_security_scheme:
        type: openIdConnect
        openIdConnectUrl: 'http://issuer1.my_openid_connect_number1_security_scheme/.well-known/openid-configuration'

    schemas:
      WombatResponse:
        type: object
        properties:
          name:
            type: string

  security:
    - my_openid_connect_number1_security_scheme:
      - read_wombats_role_from_issuer1

  tags:
    - name: "all-about-wombats"
      description: my lovely wombats are grouped here

  paths:
    /wombat:
      get:
        summary: my wombat
        description: my wombat
        operationId: getWombat
        tags:
          - "all-about-wombats"
        responses:
          '200':
            description: "all good"
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/WombatResponse'
          '400':
            description: "thing"

Environment

https://elements-demo.stoplight.io/ - whatever is deployed there.

This also propagates to other tooling that employs the spotlight rendering engine.

shoffmeister commented 1 year ago

Current state of rendering:

image

mnaumanali94 commented 1 year ago

@shoffmeister Hey. We never really got to supporting OpenID Connect in elements. We'd love to have this elements. Would you mind creating a PR for this?