Skip to content

Commit

Permalink
Specify expected format of raw field in a BOM object
Browse files Browse the repository at this point in the history
Signed-off-by: Jackline Mutua <jmutua@vmware.com>
  • Loading branch information
katmutua committed Apr 19, 2022
1 parent 0d00e34 commit e20899e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
13 changes: 6 additions & 7 deletions api/openapi-spec/conventions-server.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,15 @@ openapi: 3.0.0
info:
title: Conventions server
description: a sample conventions server.
version: 1.0.0
version: 1.0.0
license:
name: Apache-2.0
url: "https://www.apache.org/licenses/LICENSE-2.0.html"
paths:
/webhook:
post:
post:
description: a sample conventions server.
requestBody:
description: |
The PodConventionContext as defined in the API object webhooks.conventions.apps.tanzu.vmware.com API group
is the structure used for both request and response from the convention server.
content:
"application/json":
schema:
Expand All @@ -40,7 +37,9 @@ paths:
components:
schemas:
PodConventionContext:
description: a wrapper for the PodConventionContextSpec and the PodConventionContextStatus.
description: |
A wrapper for the PodConventionContextSpec and the PodConventionContextStatus. The PodConventionContext as defined in the API object
webhooks.conventions.apps.tanzu.vmware.com API group is the structure used for both request and response from the convention server.
type: object
properties:
apiVersion:
Expand Down Expand Up @@ -115,7 +114,7 @@ components:
description: bom-name
type: string
raw:
description: a byte array with the encoded content of the BOM.
description: a base64 encoded string with the encoded content of the BOM.
type: string
example: |
{
Expand Down
2 changes: 1 addition & 1 deletion docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ In the future other mechanisms may be defined to provide conventions other than

#### Webhook Helper Library

A conventions author can provide a set of conventions to the conventions controller in various ways. One way to do this, is by creating a webhook which can be written in any programming language. See the [Open API Specification](/api/openapi-spec/conventions-server.yaml) that defines how to to create your own conventions server. Applied conventions defined in the conventions server implementation created by a conventions author need to be defined as pure functions.
An extentions author can provide a set of conventions to the conventions controller in various ways. One way to do this, is by creating a webhook which can be written in any programming language. See the [Open API Specification](/api/openapi-spec/conventions-server.yaml) that defines how to to create your own conventions server. Applied conventions defined in the conventions server implementation created by a extensions author need to be defined as pure functions.

_Go Spring Boot example_

Expand Down

0 comments on commit e20899e

Please sign in to comment.