[WIP] OpenAPI-based API descriptions for CVE services #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
david-waltermire
commented
Mar 6, 2020
Comment on lines
+112
to
+116
| - name: X-API-AUTHOR | ||
| in: header | ||
| required: true | ||
| schema: | ||
| type: string |
There was a problem hiding this comment.
Pulled this out of the source code. Is this needed? Or can this be determined by the authentication context?
david-waltermire
commented
Mar 6, 2020
Comment on lines
+144
to
+215
| /cve/{cve-id}/{entity-type}/{entity-id}: | ||
| parameters: | ||
| - "$ref": "#/components/parameters/cve-id-path" | ||
| - name: entity-type | ||
| in: path | ||
| description: The type of entity (i.e., CNA, ADP) | ||
| required: true | ||
| schema: | ||
| type: string | ||
| enum: | ||
| - CNA | ||
| - ADP | ||
| - name: entity-id | ||
| in: path | ||
| description: The identifier for the entity's container | ||
| required: true | ||
| schema: | ||
| type: string | ||
| # what is this syntax? | ||
| get: | ||
| description: > | ||
| Retrieves a given container in a CVE record entry. | ||
| operationId: getCVERecordContainerById | ||
| responses: | ||
| 200: | ||
| description: > | ||
| The requested CVE record container associated with the CVE ID and entity is returned. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| # add schema for CVE 5.0 format | ||
| 404: | ||
| description: The requested CVE ID or container has not been populated. | ||
| put: | ||
| description: > | ||
| Updates a given container in a CVE record entry. | ||
| operationId: updateCVERecordContainerById | ||
| parameters: | ||
| - "$ref": "#/components/parameters/api-entity-header" | ||
| - "$ref": "#/components/parameters/api-secret-header" | ||
| - name: X-API-AUTHOR | ||
| in: header | ||
| required: true | ||
| schema: | ||
| type: string | ||
| requestBody: | ||
| description: The CVE record container data to update | ||
| content: | ||
| application/json: | ||
| schema: | ||
| # add schema for CVE 5.0 format | ||
| responses: | ||
| 200: | ||
| description: the update has been applied | ||
| content: | ||
| application/json: | ||
| schema: | ||
| # schema for the body | ||
| 400: | ||
| description: the request body is malformed | ||
| 401: | ||
| description: the client is not authenticated | ||
| 403: | ||
| description: > | ||
| the client is not authorized to update this CVE or a part that was | ||
| changed. The latter might be caused by a change to a record | ||
| container for which the authenticated entity is not authorized to | ||
| change. | ||
| 404: | ||
| description: > | ||
| the requested CVE ID has not been previously published. |
There was a problem hiding this comment.
This is a potential proposal for an endpoint that could support in-place editing of just the contents of a specific CVE record's container. This may be easier to implement on the server and client sides. I am interested in feedback from folks looking at client and server implementation.
david-waltermire
commented
Mar 6, 2020
| application/json: | ||
| schema: | ||
| type: object | ||
| # add schema for CVE 5.0 format |
There was a problem hiding this comment.
Not sure where to find the current development JSON schemas. I can point remotely to it if there is a persistent URL to use across revisions to get the latest.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the Change
Defining an OpenAPI-based specification for the CVE services. This will be useful for generating client code once complete.
Current work is in a partial draft state for review and comment. I'll keep working on it and adjust based on feedback.
Release Notes