question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

`identifier` field for License Objects

See original GitHub issue

License Objects should have an identifier field, which can hold Software Package Data Exchange license identifiers 😄

From the SPDX Specification:

Identifying the license for open source software is critical for both reporting purposes and license compliance. However, determining the license can sometimes be difficult due to a lack of information or ambiguous information. Even when licensing information is present, a lack of consistent notation can make automating the task of license detection very difficult, thus requiring vast amounts of human effort.

https://spdx.org/spdx-specification-21-web-version#h.twlc0ztnng3b

Rationale

The OpenAPI Specification, as we all know, is meant to be machine and human readable1.

Adding a standardized, machine-readable license field would allow for the following:

  • more precision w/r/t specific licenses, without the brittleness of a url field (URL rot is a thing!)
  • automatic linking to common licenses in documentation tools, even if the author omits a link
  • an index that categorizes APIs by license without relying on license.name string comparison
  • an OpenAPI client that automatically checks for compliance with services it interacts with

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:4
  • Comments:11 (7 by maintainers)

github_iconTop GitHub Comments

3reactions
MikeRalphsoncommented, Feb 28, 2020

#2105 was merged into v3.1.0-dev, look out for an RC-0 release soon.

1reaction
MikeRalphsoncommented, Jul 4, 2018

@lorenzleutgeb I’ve personally found that creates confusion with the Unlicense license. I think omitting an identifier and relying on the name/url would be preferable. Why would there not be a url for a proprietary license?

Read more comments on GitHub >

github_iconTop Results From Across the Web

What is the info property in OpenAPI? - API Handyman
When a license property is present, the License object must include at least a license name , identifier and url are optional.
Read more >
Party Identifier in Identity Resolution Match Rules
It can be any unique ID. This ID field is a foreign key that is the same as the one used in the...
Read more >
Guidelines for naming fields, controls, and objects
Use the following guidelines when naming fields, controls or objects in your Access database.
Read more >
Identifier System - an overview | ScienceDirect Topics
An object identifier is an alphanumeric string associated with the object. ... field, is to use a Digital Object Identifier (DOI) (http://www.doi.org/).
Read more >
Object identification in Alloy Navigator (API User's Guide)
The actual field that holds the object identifier depends on the class of an object. It is either Ticket (the Ticket database field)...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found