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

[OAS 3.1.0] Add identifier to License #436

Closed
jmini opened this issue Jul 2, 2020 · 1 comment · Fixed by #611
Closed

[OAS 3.1.0] Add identifier to License #436

jmini opened this issue Jul 2, 2020 · 1 comment · Fixed by #611
Assignees
Labels
OAS 3.1.0 All issues related to OpenAPI version 3.1.0 support

Comments

@jmini
Copy link
Contributor

jmini commented Jul 2, 2020

In order to support OpenAPI 3.1.0 (see #333) we need to add identifier to the License object.

Reference: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#licenseObject

An SPDX license expression for the API. The identifier field is mutually exclusive of the url field.

Example:

openapi: 3.1.0
info:
  title: Example specification
  version: "1.0"
  license:
    name: Eclipse Public License 2.0
    identifier: EPL-2.0
servers:
- url: http://localhost:8080/
paths:
  /ping:
    get:
      operationId: ping
      responses:
        200:
          description: OK

To be added:

  • The model interface License.java: new methods (getter, setter, builder)
  • The annotation definition License.java: new method
  • TCK tests

As previously discussed (#339 or #331), it is not the role of the MicroProfile OpenAPI to add checks to ensure that identifier and url can not be set simultaneously. This is up to the vendor.

@jmini jmini added the OAS 3.1.0 All issues related to OpenAPI version 3.1.0 support label Jul 2, 2020
Azquelt pushed a commit to Azquelt/microprofile-open-api that referenced this issue Mar 17, 2022
…overage

Include Spring and Vert.x coverage in JaCoCo aggregation
@MikeEdgar MikeEdgar added this to the MP OpenAPI 4.0 milestone Jan 16, 2024
@Azquelt Azquelt changed the title [OAS 3.1.0] Add identifier to License [OAS 3.1.0] Add identifier to License Apr 16, 2024
@benjamin-confino
Copy link
Contributor

Please assign this one to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OAS 3.1.0 All issues related to OpenAPI version 3.1.0 support
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants