stackql / stackql/stackql-devel

[FEATURE] Support description field in resources def

Open
#10 0 comments 0 reactions 1 assignee View on GitHub

@general-kroll-4-life is already working on this.

Since Apr 12, 2022.

enhancement v0.4
Dominant language
Go
Stars
0
Forks
0
No merged PRs in 30d

Description

Feature Description
Support a description field in the resources definitions, as shown below

If the field does not exist default its value to the value of name for backwards compatibility

Example(s)

x-stackQL-resources:
    repos:
      id: github.repos.repos
      name: repos
      title: repos
      description: a description which would show in SHOW EXTENDED RESOURCES in ...
      methods:

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.