ProductVersionApplication

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The name of the application

registration_idstring(uuid)required

Contains a unique identifier for a resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

registration_statusstringrequired

Allowed values:approvedpendingrejectedrevoked

auth_strategyOne Of
object
AuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

ProductVersionSpecDocument

object

API specification document for a product version.

api_typestringrequired

Allowed values:openapi

contentstringrequired
Example

ProductVersionSpecOperations

object

List of every operation detailed in a product version spec document.

api_typestringrequired

Allowed values:openapi

operationsarray[object]required
Show Child Parameters
Example

ApiTypeEnum

string

Allowed values:openapi

ProductDocument

object

A document for a product. This is a document that is not a part of the API specification.

idstring(uuid)requiredread-only

Contains a unique identifier used by the DocumentHub service for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

parent_document_idstring(uuid)

Contains a unique identifier used by the DocumentHub service for this resource.

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

slugstringrequired

Slug of the document. This is used in the URL to identify the document.

Example:getting-started

contentobjectrequired

content of the document

Example:{"type":"document","content":[{"type":"paragraph","content":[{"text":"Hello World","type":"text"}]}]}

Show Child Parameters
titlestringrequired

Title of the document. This is used in the Portal UI to identify the document.

Example:Hello World

Example