AMPLIFY Central - Promote API to Unified Catalog

AMPLIFY Central collection to promote an APIs to AMPLIFY Central Unified Catalog.

For authentication, the APIS require OAuth2 implicit: https://learning.postman.com/docs/postman/sending-api-requests/authorization/#implicit

To authenticate use:

Grant Type: Implicit

Auth URL:https://login.axway.com/auth/realms/Broker/protocol/openid-connect/auth?idpHint=360

To run the collection make sure your Axway Platform tenant id is set as a Postman Environment variable named "org_id".

All the resources in this collection are created in AMPLIFY API Server.

API Server oas3 specification can be downloaded from: https://apicentral.axway.com/apis/docs

API Server resource types

API Server supports two types of resources: Unscoped and Scoped.

Unscoped resources

Are top level resources that can group a set of other resources. The endpoints for Unscoped resources are defined as:

Operation	URL	Description
GET	/apis/{group}/{apiVersion}/{resourceNamesPlural}	Lists all resources of the kind related to the resourceNamesPlural and the specified group and version
POST	/apis/{group}/{apiVersion}/{resourceNamesPlural}	Creates a new resource of the kind related to the resourceNamesPlural and the specified group and version
GET	/apis/{group}/{apiVersion}/{resourceNamesPlural}/{name}	Retries a resource with a specific name
DELETE	/apis/{group}/{apiVersion}/{resourceNamesPlural}/{name}	Removes a resource with a specific name
PUT	/apis/{group}/{apiVersion}/{resourceNamesPlural}/{name}	Updates a resource with a specific name
GET	/apis/{group}/{apiVersion}/{resourceNamesPlural}/{name}/{subResourceName}	Retrieves a sub resource with the specified spec name
PUT	/apis/{group}/{apiVersion}/{resourceNamesPlural}/{name}/{subResourceName}	Updates a subresource with the specified spec name

Scoped resources

Can only be created, updated and deleted by specifying the scope in their path.

Operation	URL	Description
GET	/apis/{group}/{apiVersion}/{resourceNamesPlural}	Lists all resources of the kind related to the resourceNamesPlural and the specified group and version
GET	/apis/{group}/{apiVersion}/{scopedResourceNamesPlural}/{scopedResourceName}/{resourceNamesPlural}	Lists all the resources under their defined scope.
POST	/apis/{group}/{apiVersion}/{scopedResourceNamesPlural}/{scopedResourceName}/{resourceNamesPlural}	Creates a new resources under its defined scope.
GET	/apis/{group}/{apiVersion}/{scopedResourceNamesPlural}/{scopedResourceName}/{resourceNamesPlural}/{name}	Retries a resource with a specific name under the spcified scope name.
DELETE	/apis/{group}/{apiVersion}/{scopedResourceNamesPlural}/{scopedResourceName}/{resourceNamesPlural}/{name}	Removes a resource with a specific name under the spcified scope name
PUT	/apis/{group}/{apiVersion}/{scopedResourceNamesPlural}/{scopedResourceName}/{resourceNamesPlural}/{name}	Updates a resource with a specific name under the spcified scope name
GET	/apis/{group}/{apiVersion}/{scopedResourceNamesPlural}/{scopedResourceName}/{resourceNamesPlural}/{name}/{subResourceName}	Retrieves a sub resource with the specified spec name under the specified scope.
PUT	/apis/{group}/{apiVersion}/{scopedResourceNamesPlural}/{scopedResourceName}/{resourceNamesPlural}/{name}/{subResourceName}	Updates a subresource with the specified spec name under the specified scope.

References between resources

A resource can reference another one by name in their spec. The fields the contain a reference are annotated in the oas3 spec with x-amplify-kind-ref.

There are two types of references:

hard

soft

When a spec field has a hard reference to another resource, that means that when the referenced resource is removed, the current resource that has the reference will also be removed. Example, when an APIService gets removed, its APIServiceRevision gets removed as well.

When a spec field has a soft reference to another resource, it will not get removed when the referenced resource is removed, but its reference will get nulled out. For soft references, the API Server oas3 spec will have an additional annotation: x-amplify-kind-ref-type: "soft". Example, when a Webhook resource gets removed, the reference from ConsumerSubscriptionDefinition resources get nulled out.

For both types of resources, if they live under an unscoped resource, then when the unscoped resource gets removed, all the resources in its scope are removed. Example, when an Environment is removed, APIService, APIServiceRevision, etc. are cleaned asynchronously.

Promoting an API Service to Unified Catalog

Promoting the API Service is done through creating a ConsumerInstance resource. AMPLIFY Central will asynchronously gather information from the created API Service, API Service Revision and API Service Instance to create an entry in AMPLIFY Unified Catalog.

AMPLIFY Unified Catalog currently has support of the following definition types and subtypes:

Definition type	Definition subtype
API	swaggerv2
API	oas3
API	wsdl
API	protobuf
API	unstructured
MFT	servicedefinition
CUSTOM	unstructured

In API Server, the resource representing a Catalog Item in AMPLIFY Unified Catalog is a ConsumerInstance. The ConsumerInstance has an optional reference to an APIServiceInstance, while the APIServiceInstance is linked to an APIServiceRevision.

Mapping between API Server resources and Unified Catalog resource types:

APIServiceRevision (.spec.definition.type)	APIServiceInstance ref in ConsumerInstance	->	Definition subtype	Definition type
oas2	present	->	API	swaggerv2
oas3	present	->	API	oas3
wsdl	present	->	API	wsdl
protobuf	present	->	API	protobuf
anything else	present	->	API	unstructured
not present	not present	->	CUSTOM	unstructured

If a ConsumerInstance has a reference to an APIServiceInstance, then the type in Unified Catalog will be API. If a ConsumerInstance does not reference an APIServiceInstance, then the type is CUSTOM, subtype unstructured.

Configure Unified Catalog to send events on subscription updates

Wehbhook invocations on subscription updates in Unified Catalog is possible by creating a Webhook resource, linking it to a ConsumerSubscriptionDefinition and having the ConsumerSubscriptionDefinition references in the ConsumerInstance resource.

AUTHORIZATIONOAuth 2.0