Skip to content

Commit 4ad49ca

Browse files
authored
Merge pull request #584 from mulesoft/W-17309958-cloudgov-publish-asset-APIM-fa
W-17309958-cloudgov-publish-asset-APIM-fa
2 parents 4c48228 + 15ee117 commit 4ad49ca

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

modules/ROOT/pages/create-instance-task-mule.adoc

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,55 @@ include::partial$api-configuration-tables.adoc[tags=mule-proxy-upstream]
5959
+
6060
include::partial$task-add-api-instance.adoc[tags=last-steps]
6161

62+
== Create New API Asset
63+
64+
NOTE: This feature is only available on GovCloud environments. If you want to create an API asset in other environments, refer to xref:exchange::to-create-an-asset.adoc#create-an-api-asset[]
65+
66+
An API asset specifies an interface completely, including its functions, descriptions, how to handle return codes, and dependencies.
67+
68+
Creating an asset sets the asset type, which cannot be changed. All versions of an asset always have the same type.
69+
70+
To create an API asset:
71+
72+
. In API Manager, click *Add API*.
73+
74+
. From the dropdown list, select *Create new API asset*
75+
76+
. Enter a name for the asset.
77+
78+
. Select the asset type from the drop-down list:
79+
80+
** REST API - RAML: Provide a RAML API specification file. RAML specifications must be a RAML file (.raml).
81+
82+
** REST API - OAS: Provide an OAS API specification file. OAS specifications can be either a YAML (.yaml) or JSON (.json) file. Exchange supports OAS 2.0 and OAS 3.0 specifications.
83+
84+
** SOAP API - WSDL: Provide a WSDL API specification file. SOAP specifications file can be either a WSDL (.wsdl) or XML (.xml) file.
85+
86+
** AsyncAPI: Provide an AsyncAPI specification file in a YAML (.yaml) or JSON (.json) file.
87+
88+
** AsyncAPI with Avro schemas: Provide an Avro fragment in an AVSC (.avsc) file.
89+
90+
** API Spec Fragment - RAML: Provide an API Fragment RAML specification file. Fragment specifications must be a RAML file (.raml).
91+
92+
** API Spec Fragment - JSON: Provide an API Fragment JSON specification (.json) file.
93+
94+
** API Spec Fragment - OpenAPI Specification (OAS): Provide an API Fragment OpenAPI specification file either JSON or YAML.
95+
96+
** HTTP API: This asset does not require a file. This asset type provides an API endpoint that is defined by API Manager.
97+
98+
. For assets that require a file:
99+
100+
.. Click *Choose File* to locate the API specification file.
101+
102+
.. Select the main file of the API. +
103+
If the file is a ZIP, the selected main file must be in the root directory of the ZIP file. If the file is not a ZIP or if the file is a ZIP file with only one main file, then the main file is selected automatically.
104+
105+
. If you want to edit the *GroupId*, *AssetId*, *Version*, and *API version* (GAV), click *Advanced*. +
106+
Exchange generates the group ID, asset ID, and version (GAV) for you, and you can change these values as needed. You can change an API’s asset version and version separately. Use the advanced settings to change the asset version.
107+
108+
. Choose an option for *Lifecycle state*. The default is Stable.
109+
110+
. Click *Publish*.
62111

63112
//promote-api
64113
include::partial$task-promote-api.adoc[]

0 commit comments

Comments
 (0)