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

Missing content OpenID security scheme #2271

Open
shoffmeister opened this issue Oct 28, 2022 · 2 comments
Open

Missing content OpenID security scheme #2271

shoffmeister opened this issue Oct 28, 2022 · 2 comments
Labels
enhancement New feature or request portal triaged

Comments

@shoffmeister
Copy link

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: [email protected]
     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
Copy link
Author

Current state of rendering:

image

@mnaumanali94 mnaumanali94 added the enhancement New feature or request label Nov 3, 2022
@mnaumanali94
Copy link
Contributor

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request portal triaged
Projects
None yet
Development

No branches or pull requests

3 participants