Operations Object
REST APIs only: Includes information about one or more operations associated with an API, represented as an array. For REST APIs, this is required in the request message when adding or updating an API version.
Use Operations to define the sets of resources that you want to manage. As a simple example, you could have one operation called "get" defined as follows:
- Method: GET,
- Path: /{path:.+|}
- Content-Type: */*
This would then manage all GET calls to your endpoint under a single logical operation. It would also generate documentation with a single resource ('/').
The above is only for the sake of illustrationl. In practical terms, users typically define their APIs with multiple operations, with the granularity matching the desired documentation. This usually manifests itself as a single operation per method per resource, plus special cases such as login.
This object is used by the following operations:
- Operations that reference the APIVersion object
- Operations that reference the TargetAPI object
- Operations that reference the APIImplementation object
The properties included in the Operations object are listed below.
| Property | Type | Required | Description |
|---|---|---|---|
| Operation | Operation[ ] | Required | One or more operations relating to the API. |