Put organisations schemas components

Update a schema component.

PUT /organisations/{organisationId}/schemas/{id}/components/{ref}

cURL

cURL

curl --request PUT \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/schemas/{id}/components/{ref} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": "<string>",
  "definition": {},
  "schemaId": "<string>"
}
'

200

{
  "ref": "<string>",
  "definition": {},
  "schemaId": "<string>"
}

Authorizations

Authorization · string · header · required

Path Parameters

organisationId · string · required

id · string · required

ref · string · required

Body

application/json

UpdateSchemaComponentRequest is the request body for updating a Schema Components.

ref · string · required

The ref of the schema object, for OpenAPI this will be how operations ref to this object with the ref field.

definition · object · required

The definition of the schema object following OpenAPI specification.

schemaId · string

The ID of the schema this object belongs to.

Response

200

application/json

UpdateSchemaComponentResponse is the response definition after updating a schema component.

ref · string · required

The ref of the schema object, for OpenAPI this will be how operations ref to this object with the ref field.

definition · object · required

The definition of the schema object following OpenAPI specification.

schemaId · string

The ID of the schema this object belongs to.