Skip to content

Update OpenAPI docs #162

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.

Sign up for GitHub

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

Merged
nscuro merged 1 commit into from
Jun 14, 2026
Merged

Update OpenAPI docs #162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 142 additions & 5 deletions docs/reference/api/openapi-v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2498,7 +2498,7 @@ paths:
schema:
type: array
items:
$ref: "#/components/schemas/License"
$ref: "#/components/schemas/LicenseResponse"
description: A list of all licenses with complete metadata for each license
headers:
X-Total-Count:
Expand All @@ -2522,13 +2522,13 @@ paths:
content:
'*/*':
schema:
$ref: "#/components/schemas/License"
$ref: "#/components/schemas/CreateLicenseRequest"
responses:
"201":
content:
application/json:
schema:
$ref: "#/components/schemas/License"
$ref: "#/components/schemas/LicenseResponse"
description: The created license
"401":
description: Unauthorized
Expand All @@ -2550,7 +2550,7 @@ paths:
schema:
type: array
items:
$ref: "#/components/schemas/License"
$ref: "#/components/schemas/ConciseLicenseResponse"
description: A concise listing of all licenses
headers:
X-Total-Count:
Expand Down Expand Up @@ -2607,7 +2607,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/License"
$ref: "#/components/schemas/LicenseResponse"
description: A specific license
"401":
description: Unauthorized
Expand Down Expand Up @@ -10074,6 +10074,39 @@ components:
- propertyName
- propertyType
- uuid
ConciseLicenseResponse:
type: object
properties:
isCustomLicense:
type: boolean
description: Whether the license is a custom license created by a user
isDeprecatedLicenseId:
type: boolean
description: Whether the licenseId has been deprecated by SPDX
isFsfLibre:
type: boolean
description: Whether the license is FSF libre
isOsiApproved:
type: boolean
description: Whether the license is approved by the OSI
licenseId:
type: string
description: Identifier of the license
name:
type: string
description: Display name of the license
uuid:
type: string
format: uuid
description: UUID of the license
required:
- isCustomLicense
- isDeprecatedLicenseId
- isFsfLibre
- isOsiApproved
- licenseId
- name
- uuid
ConciseProject:
type: object
description: A concise representation of a project
Expand Down Expand Up @@ -10319,6 +10352,52 @@ components:
pattern: "^[\\p{IsWhite_Space}\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]*$"
required:
- name
CreateLicenseRequest:
type: object
properties:
isDeprecatedLicenseId:
type: boolean
description: Whether the licenseId has been deprecated by SPDX
isFsfLibre:
type: boolean
description: Whether the license is FSF libre
isOsiApproved:
type: boolean
description: Whether the license is approved by the OSI
licenseComments:
type: string
description: Comments about the license
licenseId:
type: string
description: Identifier of the license
maxLength: 255
minLength: 1
pattern: "^[a-zA-Z0-9_.\\-+]*$"
licenseText:
type: string
description: Full license text
name:
type: string
description: Display name of the license
maxLength: 255
minLength: 1
pattern: "^[\\p{IsWhite_Space}\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]*$"
seeAlso:
type: array
description: Additional URLs with information about the license
items:
type: string
description: Additional URLs with information about the license
standardLicenseHeader:
type: string
description: Standard license header typically added to the top of source
code
standardLicenseTemplate:
type: string
description: Standard license template used to derive the license text
required:
- licenseId
- name
CreateNotificationPublisherRequest:
type: object
properties:
Expand Down Expand Up @@ -10955,6 +11034,64 @@ components:
- name
- riskWeight
- uuid
LicenseResponse:
type: object
properties:
isCustomLicense:
type: boolean
description: Whether the license is a custom license created by a user
isDeprecatedLicenseId:
type: boolean
description: Whether the licenseId has been deprecated by SPDX
isFsfLibre:
type: boolean
description: Whether the license is FSF libre
isOsiApproved:
type: boolean
description: Whether the license is approved by the OSI
licenseComments:
type: string
description: Comments about the license
licenseGroups:
type: array
description: License groups the license belongs to
items:
$ref: "#/components/schemas/LicenseGroup"
licenseId:
type: string
description: Identifier of the license
licenseText:
type: string
description: Full license text
name:
type: string
description: Display name of the license
seeAlso:
type: array
description: Additional URLs with information about the license
items:
type: string
description: Additional URLs with information about the license
standardLicenseHeader:
type: string
description: Standard license header typically added to the top of source
code
standardLicenseTemplate:
type: string
description: Standard license template used to derive the license text
uuid:
type: string
format: uuid
description: UUID of the license
required:
- isCustomLicense
- isDeprecatedLicenseId
- isFsfLibre
- isOsiApproved
- licenseGroups
- licenseId
- name
- uuid
ListProjectsResponseItem:
type: object
properties:
Expand Down