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 {% konnect_roles_table %} #509

Merged
merged 2 commits into from
Feb 24, 2025
Merged

Add {% konnect_roles_table %} #509

merged 2 commits into from
Feb 24, 2025

Conversation

fabianrbz
Copy link
Collaborator

@fabianrbz fabianrbz commented Feb 24, 2025

Description

Add {% konnect_roles_table %} block.

Renders a table with the roles + description of the provided schema

Usage:
Pass the name of the schema as defined in
api-specs/konnect/identity/vX/openapi.yaml

The name of the schemas can be found under:
components.responses.Roles.content.application/json.schema.properties

{% konnect_roles_table %}
schema: audit_logs
{% endkonnect_roles_table %}

TODO:

  • The following roles are not defined in the spec
    - Networks
    - Service Catalog
    - Portals
    - Application Auth Strategies
    - DCR
  • Teams aren't defined in the spec

Related #372

Preview Links

Checklist

  • Every page is page one.
  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Updated sources.yaml. For more info, review track docs changes
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.

Renders a table with the roles + description of the provided schema

Usage:
Pass the name of the schema as defined in
`api-specs/konnect/identity/vX/openapi.yaml`

The name of the schemas can be found under:
`components.responses.Roles.content.application/json.schema.properties`

```
{% konnect_roles_table %}
schema: audit_logs
{% endkonnect_roles_table %}
```
@fabianrbz fabianrbz requested a review from a team as a code owner February 24, 2025 10:15
Copy link

netlify bot commented Feb 24, 2025

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit d4b20ce
🔍 Latest deploy log https://app.netlify.com/sites/kongdeveloper/deploys/67bc4752f2e13c00086615ae
😎 Deploy Preview https://deploy-preview-509--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@fabianrbz fabianrbz merged commit 40020a2 into main Feb 24, 2025
10 checks passed
@fabianrbz fabianrbz deleted the team-and-roles branch February 24, 2025 20:37
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