Redocly / Redocly/openapi-starter

x-traitTag and x-summary usage examples

Open
#130 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
C#
Stars
220
Forks
133
PR merge metrics
No merged PRs in 30d

Description

Redocly tools have support for an extension called x-traitTag. Include it as an example in our OpenAPI starter.

More information about the feature from our docs: https://redocly.com/docs/api-reference-docs/specification-extensions/x-trait-tag/

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the OpenAPI starter's example content and use the linked x-traitTag documentation as the reference. Add the requested x-traitTag and x-summary usage examples. Done means the starter includes both examples in valid OpenAPI content.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.