netlify / netlify/open-api

Add license information

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

Nobody has claimed this yet.

enhancement specification
Dominant language
Go
Stars
323
Forks
133
Avg merge
2d 8h
Merged PRs (30d)
2

Description

The OpenAPI has a license field which describes the license information for the exposed API.

This shows up in the generated documentation and might be nice to have. Now I am not sure if this covers the API documentation or the API methods/properties. This repository is MIT licensed, but I am not sure whether this field applies to the same thing.

Would adding this field be a good idea? If so, please let me know which license I should add, and I can submit a PR.

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.

Research direction

Start by locating where this repository defines its OpenAPI Info Object and where generated documentation is produced. Read the OpenAPI license field specification and determine whether it describes Netlify's exposed API or the repository documentation. Done means the intended license information is represented consistently in the specification and generated documentation, with relevant tests updated if present.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, openapi
Domain
api, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.