Merge pull request #8642 from reasonerjt/swagger-doc-update

Fix issue in API swagger doc
This commit is contained in:
Daniel Jiang 2019-08-14 14:23:59 +08:00 committed by GitHub
commit a545b460ed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3684,7 +3684,7 @@ paths:
description: Unexpected internal errors. description: Unexpected internal errors.
'/projects/{project_id}/webhook/policies': '/projects/{project_id}/webhook/policies':
get: get:
sumary: List project webhook policies. summary: List project webhook policies.
description: | description: |
This endpoint returns webhook policies of a project. This endpoint returns webhook policies of a project.
parameters: parameters:
@ -3712,7 +3712,7 @@ paths:
'500': '500':
description: Unexpected internal errors. description: Unexpected internal errors.
post: post:
sumary: Create project webhook policy. summary: Create project webhook policy.
description: | description: |
This endpoint create a webhook policy if the project does not have one. This endpoint create a webhook policy if the project does not have one.
parameters: parameters:
@ -3757,7 +3757,7 @@ paths:
in: path in: path
description: The id of webhook policy. description: The id of webhook policy.
required: true required: true
type: int64 type: integer
format: int64 format: int64
tags: tags:
- Products - Products
@ -3791,7 +3791,7 @@ paths:
in: path in: path
description: The id of webhook policy. description: The id of webhook policy.
required: true required: true
type: int64 type: integer
format: int64 format: int64
- name: policy - name: policy
in: body in: body
@ -3829,7 +3829,7 @@ paths:
in: path in: path
description: The id of webhook policy. description: The id of webhook policy.
required: true required: true
type: int64 type: integer
format: int64 format: int64
tags: tags:
- Products - Products
@ -3908,7 +3908,7 @@ paths:
description: Internal server errors. description: Internal server errors.
'/projects/{project_id}/webhook/jobs': '/projects/{project_id}/webhook/jobs':
get: get:
sumary: List project webhook jobs summary: List project webhook jobs
description: | description: |
This endpoint returns webhook jobs of a project. This endpoint returns webhook jobs of a project.
parameters: parameters:
@ -4083,16 +4083,20 @@ definitions:
description: 'The public status of the project. The valid values are "true", "false".' description: 'The public status of the project. The valid values are "true", "false".'
enable_content_trust: enable_content_trust:
type: string type: string
description: 'Whether content trust is enabled or not. If it is enabled, user cann''t pull unsigned images from this project. The valid values are "true", "false".' description: 'Whether content trust is enabled or not. If it is enabled, user can''t pull unsigned images from this project. The valid values are "true", "false".'
prevent_vul: prevent_vul:
type: string type: string
description: 'Whether prevent the vulnerable images from running. The valid values are "true", "false".' description: 'Whether prevent the vulnerable images from running. The valid values are "true", "false".'
severity: severity:
type: string type: string
description: 'If the vulnerability is high than severity defined here, the images cann''t be pulled. The valid values are "negligible", "low", "medium", "high", "critical".' description: 'If the vulnerability is high than severity defined here, the images can''t be pulled. The valid values are "negligible", "low", "medium", "high", "critical".'
auto_scan: auto_scan:
type: string type: string
description: 'Whether scan images automatically when pushing. The valid values are "true", "false".' description: 'Whether scan images automatically when pushing. The valid values are "true", "false".'
reuse_sys_cve_whitelist:
type: string
description: 'Whether this project reuse the system level CVE whitelist as the whitelist of its own. The valid values are "true", "false".
If it is set to "true" the actual whitelist associate with this project, if any, will be ignored.'
ProjectSummary: ProjectSummary:
type: object type: object
properties: properties:
@ -5732,7 +5736,7 @@ definitions:
description: The webhook job ID. description: The webhook job ID.
policy_id: policy_id:
type: integer type: integer
fromat: int64 format: int64
description: The webhook policy ID. description: The webhook policy ID.
event_type: event_type:
type: string type: string