OWASP Project
Title: OWASP Project
| |
| Type | object |
| Required | No |
| Additional properties | Not allowed |
Description: OWASP project schema
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| + audience | No | array of enum (of string) | No | - | The intended audience for the project. |
| - blog | No | string | No | - | Project's blog. |
| - community | No | array | No | - | A list of community platforms associated with the project. |
| - demo | No | array of string | No | - | Optional URLs to the project demo. |
| - documentation | No | array of string | No | - | Optional URLs to project documentation. |
| - downloads | No | array of string | No | - | Optional list of download URLs. |
| - events | No | array | No | - | Events related to the project. |
| + leaders | No | array | No | - | Leaders of the project. |
| + level | No | enum (of integer or number) | No | - | Project level. |
| - license | No | array of enum (of string) | No | - | The licenses of the project. |
| - logo | No | array | No | - | Logo information for the project. |
| - mailing_list | No | array | No | - | The optional mailing list associated with the project. |
| + name | No | string | No | - | The unique name of the project. |
| + pitch | No | string | No | - | The project pitch. |
| - repositories | No | array | No | - | Repositories associated with the project. |
| - social_media | No | array | No | - | Social media information for the project |
| - sponsors | No | array | No | - | Sponsors of the project. |
| - tags | No | array of string | No | - | Tags for the project |
| + type | No | enum (of string) | No | - | The type of the project: code, documentation or tool. |
| - website | No | string | No | - | The official website of the project. |
1. Property OWASP Project > audience
| |
| Type | array of enum (of string) |
| Required | Yes |
Description: The intended audience for the project.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
1.1. OWASP Project > audience > audience items
| |
| Type | enum (of string) |
| Required | No |
Must be one of: * "breaker" * "builder" * "defender"
2. Property OWASP Project > blog
| |
| Type | string |
| Required | No |
| Format | uri |
Description: Project's blog.
Description: A list of community platforms associated with the project.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| Community | Community |
Title: Community
| |
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | common.json#/definitions/community |
Description: Community
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| - description | No | string | No | - | A brief description of the community. |
| + name | No | string | No | - | The name of the community. |
| + platform | No | enum (of string) | No | - | The platform used by the community |
| + url | No | string | No | - | The URL of the community. |
Description: A brief description of the community.
| Restrictions | |
| Min length | 10 |
Description: The name of the community.
| Restrictions | |
| Min length | 3 |
| |
| Type | enum (of string) |
| Required | Yes |
Description: The platform used by the community
Must be one of: * "discord" * "github-discussions" * "slack"
| |
| Type | string |
| Required | Yes |
| Format | uri |
Description: The URL of the community.
4. Property OWASP Project > demo
| |
| Type | array of string |
| Required | No |
Description: Optional URLs to the project demo.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| demo items | - |
4.1. OWASP Project > demo > demo items
| |
| Type | string |
| Required | No |
| Format | uri |
5. Property OWASP Project > documentation
| |
| Type | array of string |
| Required | No |
Description: Optional URLs to project documentation.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
5.1. OWASP Project > documentation > documentation items
| |
| Type | string |
| Required | No |
| Format | uri |
6. Property OWASP Project > downloads
| |
| Type | array of string |
| Required | No |
Description: Optional list of download URLs.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
6.1. OWASP Project > downloads > downloads items
| |
| Type | string |
| Required | No |
| Format | uri |
7. Property OWASP Project > events
Description: Events related to the project.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| Event | Event |
7.1. OWASP Project > events > Event
Title: Event
| |
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | common.json#/definitions/event |
Description: Event
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| - description | No | string | No | - | A brief description of event |
| - title | No | string | No | - | Title of the event |
| + url | No | string | No | - | URL of the event |
7.1.1. Property OWASP Project > events > Event > description
Description: A brief description of event
| Restrictions | |
| Min length | 10 |
7.1.2. Property OWASP Project > events > Event > title
Description: Title of the event
| Restrictions | |
| Min length | 10 |
7.1.3. Property OWASP Project > events > Event > url
| |
| Type | string |
| Required | Yes |
| Format | uri |
Description: URL of the event
8. Property OWASP Project > leaders
Description: Leaders of the project.
| Array restrictions |
| Min items | 1 |
| Max items | 5 |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| Person | Person |
8.1. OWASP Project > leaders > Person
Title: Person
| |
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | common.json#/definitions/person |
Description: Person
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| - email | No | string | No | - | E-mail address |
| - github | No | string | No | - | GitHub username |
| + name | No | string | No | - | Full name |
| - slack | No | string | No | - | Slack username |
8.1.1. Property OWASP Project > leaders > Person > email
| |
| Type | string |
| Required | No |
| Format | email |
Description: E-mail address
| Restrictions | |
| Min length | 5 |
8.1.2. Property OWASP Project > leaders > Person > github
Description: GitHub username
| Restrictions | |
| Must match regular expression | ^[a-zA-Z0-9-]{1,39}$ Test |
8.1.3. Property OWASP Project > leaders > Person > name
Description: Full name
| Restrictions | |
| Min length | 2 |
8.1.4. Property OWASP Project > leaders > Person > slack
Description: Slack username
| Restrictions | |
| Must match regular expression | ^[a-zA-Z0-9._-]{1,21}$ Test |
9. Property OWASP Project > level
Title: Project level.
| |
| Type | enum (of integer or number) |
| Required | Yes |
| Default | 2 |
Description: The numeric level of the project.
Must be one of: * 2 * 3 * 3.5 * 4
10. Property OWASP Project > license
| |
| Type | array of enum (of string) |
| Required | No |
Description: The licenses of the project.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
10.1. OWASP Project > license > license items
| |
| Type | enum (of string) |
| Required | No |
Must be one of: * "AGPL-3.0" * "Apache License 2.0" * "Apache-2.0" * "BSD-2-Clause" * "BSD-3-Clause" * "CC-BY-4.0" * "CC-BY-SA-4.0" * "CC0-1.0" * "EUPL-1.2" * "GPL-2.0" * "GPL-3.0" * "LGPL-2.1" * "LGPL-3.0" * "MIT" * "MPL-2.0" * "OTHER"
11. Property OWASP Project > logo
Description: Logo information for the project.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| Logo | A logo |
11.1. OWASP Project > logo > Logo
Title: Logo
| |
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | common.json#/definitions/logo |
Description: A logo
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| + small | No | string | No | - | Logo size should be 192x192 pixels. |
| + medium | No | string | No | - | Logo size should be 256x256 pixels. |
| + large | No | string | No | - | Logo size should be 512x512 pixels. |
11.1.1. Property OWASP Project > logo > Logo > small
| |
| Type | string |
| Required | Yes |
| Format | uri |
Description: Logo size should be 192x192 pixels.
11.1.2. Property OWASP Project > logo > Logo > medium
| |
| Type | string |
| Required | Yes |
| Format | uri |
Description: Logo size should be 256x256 pixels.
11.1.3. Property OWASP Project > logo > Logo > large
| |
| Type | string |
| Required | Yes |
| Format | uri |
Description: Logo size should be 512x512 pixels.
12. Property OWASP Project > mailing_list
Description: The optional mailing list associated with the project.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| Mailing List | Mail List |
12.1. OWASP Project > mailing_list > Mailing List
Title: Mailing List
| |
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | common.json#/definitions/mailing_list |
Description: Mail List
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| - description | No | string | No | - | Description of mailing list |
| - email | No | string | No | - | E-mail address |
| - title | No | string | No | - | Title of mailing list |
| + url | No | string | No | - | URL to mailing list |
12.1.1. Property OWASP Project > mailing_list > Mailing List > description
Description: Description of mailing list
| Restrictions | |
| Min length | 10 |
12.1.2. Property OWASP Project > mailing_list > Mailing List > email
| |
| Type | string |
| Required | No |
| Format | email |
Description: E-mail address
| Restrictions | |
| Min length | 5 |
12.1.3. Property OWASP Project > mailing_list > Mailing List > title
Description: Title of mailing list
| Restrictions | |
| Min length | 10 |
12.1.4. Property OWASP Project > mailing_list > Mailing List > url
| |
| Type | string |
| Required | Yes |
| Format | uri |
Description: URL to mailing list
13. Property OWASP Project > name
Description: The unique name of the project.
| Restrictions | |
| Min length | 8 |
14. Property OWASP Project > pitch
Description: The project pitch.
| Restrictions | |
| Min length | 10 |
15. Property OWASP Project > repositories
Description: Repositories associated with the project.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| Repository | A repository |
15.1. OWASP Project > repositories > Repository
Title: Repository
| |
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | common.json#/definitions/repository |
Description: A repository
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| - changelog | No | string | No | - | Link to the changelog |
| - code_of_conduct | No | string | No | - | Link to the code of conduct |
| - contribution_guide | No | string | No | - | Link to the contribution guide |
| - description | No | string | No | - | Repository description |
| - name | No | string | No | - | Repository name |
| + url | No | string | No | - | The repository URL. |
15.1.1. Property OWASP Project > repositories > Repository > changelog
| |
| Type | string |
| Required | No |
| Format | uri |
Description: Link to the changelog
| Restrictions | |
| Min length | 5 |
15.1.2. Property OWASP Project > repositories > Repository > code_of_conduct
| |
| Type | string |
| Required | No |
| Format | uri |
Description: Link to the code of conduct
| Restrictions | |
| Min length | 5 |
15.1.3. Property OWASP Project > repositories > Repository > contribution_guide
| |
| Type | string |
| Required | No |
| Format | uri |
Description: Link to the contribution guide
| Restrictions | |
| Min length | 5 |
15.1.4. Property OWASP Project > repositories > Repository > description
Description: Repository description
| Restrictions | |
| Min length | 5 |
15.1.5. Property OWASP Project > repositories > Repository > name
Description: Repository name
| Restrictions | |
| Min length | 3 |
15.1.6. Property OWASP Project > repositories > Repository > url
| |
| Type | string |
| Required | Yes |
| Format | uri |
Description: The repository URL.
| Restrictions | |
| Min length | 5 |
Description: Social media information for the project
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| Social media | A social media platform for the project |
Title: Social media
| |
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | common.json#/definitions/social_media |
Description: A social media platform for the project
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| - description | No | string | No | - | Description of the social media platform |
| + platform | No | enum (of string) | No | - | The type of social media platform. |
| + url | No | string | No | - | The URL of the social media profile. |
Description: Description of the social media platform
| Restrictions | |
| Min length | 5 |
| |
| Type | enum (of string) |
| Required | Yes |
Description: The type of social media platform.
Must be one of: * "bluesky" * "linkedin" * "mastodon" * "x" * "youtube"
| |
| Type | string |
| Required | Yes |
| Format | uri |
Description: The URL of the social media profile.
Description: Sponsors of the project.
| Array restrictions |
| Min items | 1 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| Sponsor | A sponsor entity |
Title: Sponsor
| |
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | common.json#/definitions/sponsor |
Description: A sponsor entity
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| - description | No | string | No | - | A brief description of the sponsor |
| - logo | No | string | No | - | The URL of the sponsor's logo |
| + name | No | string | No | - | The name of the sponsor or organization |
| + url | No | string | No | - | The URL of the sponsor. |
Description: A brief description of the sponsor
| Restrictions | |
| Min length | 5 |
| |
| Type | string |
| Required | No |
| Format | uri |
Description: The URL of the sponsor's logo
Description: The name of the sponsor or organization
| Restrictions | |
| Min length | 5 |
| |
| Type | string |
| Required | Yes |
| Format | uri |
Description: The URL of the sponsor.
| |
| Type | array of string |
| Required | No |
Description: Tags for the project
| Array restrictions |
| Min items | 3 |
| Max items | N/A |
| Items unicity | True |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
| tags items | - |
19. Property OWASP Project > type
| |
| Type | enum (of string) |
| Required | Yes |
Description: The type of the project: code, documentation or tool.
Must be one of: * "code" * "documentation" * "tool"
20. Property OWASP Project > website
| |
| Type | string |
| Required | No |
| Format | uri |
Description: The official website of the project.
| Restrictions | |
| Min length | 4 |