diff --git a/Gemfile.lock b/Gemfile.lock index 6ee6760..02f70f0 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -76,7 +76,7 @@ DEPENDENCIES webrick (~> 1.7) RUBY VERSION - ruby 3.0.2p107 + ruby 2.7.2p137 BUNDLED WITH 2.2.22 diff --git a/api/reference/1.0/app_configurations/list.md b/api/reference/1.0/app_configurations/list.md index 4104d01..b7e0981 100644 --- a/api/reference/1.0/app_configurations/list.md +++ b/api/reference/1.0/app_configurations/list.md @@ -8,7 +8,7 @@ labels: {% labels %} -Retrieve the App Configurations owned by the specified Company. +Retrieve the App Configurations owned by the specified Company. Icons can be included with a query parameter `?include=icon` {% filters app_configuration %} diff --git a/api/reference/1.0/app_configurations/relationships/app_surfaces/add_relationships.md b/api/reference/1.0/app_configurations/relationships/app_surfaces/add_relationships.md new file mode 100644 index 0000000..ec4b771 --- /dev/null +++ b/api/reference/1.0/app_configurations/relationships/app_surfaces/add_relationships.md @@ -0,0 +1,9 @@ +--- +title: Add relationships +--- + +# Add AppSurfaces to an AppConfiguration + +Insert AppSurfaces into the specified AppConfiguration. + +{% scenario app_configurations_relationships_app_surfaces.create app_configurations.add_app_surfaces_to_the_app_configuration %} diff --git a/api/reference/1.0/app_configurations/relationships/app_surfaces/list_related.md b/api/reference/1.0/app_configurations/relationships/app_surfaces/list_related.md new file mode 100644 index 0000000..cb8dcf6 --- /dev/null +++ b/api/reference/1.0/app_configurations/relationships/app_surfaces/list_related.md @@ -0,0 +1,9 @@ +--- +title: List related +--- + +# List related AppSurfaces + +Retrieve the AppSurfaces related to the specified AppConfiguration. + +{% scenario app_configuration_relationship_app_surfaces.index app_configurations.list_the_app_surfaces_for_an_app_configuration %} diff --git a/api/reference/1.0/app_configurations/relationships/app_surfaces/list_relationships.md b/api/reference/1.0/app_configurations/relationships/app_surfaces/list_relationships.md new file mode 100644 index 0000000..17f9e93 --- /dev/null +++ b/api/reference/1.0/app_configurations/relationships/app_surfaces/list_relationships.md @@ -0,0 +1,9 @@ +--- +title: List relationships +--- + +# List AppSurface relationships for an AppConfiguration + +Retrieve the relationship linkage for the AppSurfaces related to the specified AppConfiguration. + +{% scenario app_configurations_relationships_app_surfaces.show app_configurations.list_the_app_surfaces_for_an_app_configuration %} diff --git a/api/reference/1.0/app_configurations/relationships/app_surfaces/remove_relationships.md b/api/reference/1.0/app_configurations/relationships/app_surfaces/remove_relationships.md new file mode 100644 index 0000000..003b6e1 --- /dev/null +++ b/api/reference/1.0/app_configurations/relationships/app_surfaces/remove_relationships.md @@ -0,0 +1,9 @@ +--- +title: Remove relationships +--- + +# Remove AppSurfaces from an AppConfiguration + +Remove AppSurfaces from the specified AppConfiguration. + +{% scenario app_configurations_relationships_app_surfaces.delete app_configurations.remove_app_surface_from_an_app_configuration %} diff --git a/api/reference/1.0/app_configurations/relationships/app_surfaces/replace_relationships.md b/api/reference/1.0/app_configurations/relationships/app_surfaces/replace_relationships.md new file mode 100644 index 0000000..24ba3dd --- /dev/null +++ b/api/reference/1.0/app_configurations/relationships/app_surfaces/replace_relationships.md @@ -0,0 +1,9 @@ +--- +title: Replace relationships +--- + +# Replace AppSurfaces on an AppConfiguration + +Replace all existing AppSurfaces on a AppConfiguration with the specified AppSurfaces + +{% scenario app_configurations_relationships_app_surfaces.update app_configurations.replace_app_surfaces_on_an_app_configuration %} diff --git a/api/reference/1.0/app_configurations/relationships/icon/create.md b/api/reference/1.0/app_configurations/relationships/icon/create.md new file mode 100644 index 0000000..8d0d8e3 --- /dev/null +++ b/api/reference/1.0/app_configurations/relationships/icon/create.md @@ -0,0 +1,147 @@ +--- +title: Create +labels: + - unstable +--- + +# Create an Icon for an AppConfiguration + +{% labels %} + +Icons are processed asynchronously and have a `status` attribute representing the current status of the Icon. + +{% alert info, Note %} +This endpoint expects multipart requests. Icons must be 4 MB or less. +{% endalert %} + +
file
+ POST app_configurations/:id/icon
+ curl https://reactor.adobe.io/app_configurations/:id/icon \
+ -H "Accept: application/vnd.api+json;revision=1" \
+ -H "Content-Type: multipart/form-data" \
+ -H "Authorization: Bearer [TOKEN]" \
+ -H "X-Api-Key: [KEY]" \
+ -H "X-Gw-Ims-Org-Id: [ORG_ID]" \
+ -F "file"="@[PATH]"
+
+ {
+ "data": {
+ "id": "ICd1de2829fd4743c5bc45b98d9d01a396",
+ "type": "icons",
+ "attributes": {
+ "url": "https://assets.adobedtm.com/icons/17e0df72ece8/ICd1de2829fd4743c5bc45b98d9d01a396.png",
+ "status": "pending",
+ "created_at": "2022-02-04T21:14:23.483Z",
+ "updated_at": "2022-02-04T21:14:23.483Z"
+ },
+ "relationships": {
+ "resource": {
+ "links": {
+ "related": "https://reactor.adobe.io/app_configurations/AC082ee39971a9444fb133e7610ae1e9f7"
+ },
+ "data": {
+ "id": "AC082ee39971a9444fb133e7610ae1e9f7",
+ "type": "app_configurations"
+ }
+ }
+ },
+ "links": {
+ "resource": "https://reactor.adobe.io/app_configurations/AC082ee39971a9444fb133e7610ae1e9f7",
+ "self": "https://reactor.adobe.io/icons/ICd1de2829fd4743c5bc45b98d9d01a396"
+ }
+ }
+}
+ file
+ POST app_surfaces/:id/icon
+ curl https://reactor.adobe.io/app_surfaces/:id/icon \
+ -H "Accept: application/vnd.api+json;revision=1" \
+ -H "Content-Type: multipart/form-data" \
+ -H "Authorization: Bearer [TOKEN]" \
+ -H "X-Api-Key: [KEY]" \
+ -H "X-Gw-Ims-Org-Id: [ORG_ID]" \
+ -F "file"="@[PATH]"
+
+ {
+ "data": {
+ "id": "ICf76b9de5b229435bb76802427a88464b",
+ "type": "icons",
+ "attributes": {
+ "url": "https://assets.adobedtm.com/icons/17e0df72ece8/ICf76b9de5b229435bb76802427a88464b.png",
+ "status": "pending",
+ "created_at": "2022-02-04T21:14:23.483Z",
+ "updated_at": "2022-02-04T21:14:23.483Z"
+ },
+ "relationships": {
+ "resource": {
+ "links": {
+ "related": "https://reactor.adobe.io/app_surfaces/ASb763e208e4f64c86a4ce6445604355ce"
+ },
+ "data": {
+ "id": "ASb763e208e4f64c86a4ce6445604355ce",
+ "type": "app_surfaces"
+ }
+ }
+ },
+ "links": {
+ "resource": "https://reactor.adobe.io/app_surfaces/ASb763e208e4f64c86a4ce6445604355ce",
+ "self": "https://reactor.adobe.io/icons/ICf76b9de5b229435bb76802427a88464b"
+ }
+ }
+}
+ file
+ PATCH icons/:id
+ curl https://reactor.adobe.io/icons/:id \
+ -H "Accept: application/vnd.api+json;revision=1" \
+ -H "Content-Type: multipart/form-data" \
+ -H "Authorization: Bearer [TOKEN]" \
+ -H "X-Api-Key: [KEY]" \
+ -H "X-Gw-Ims-Org-Id: [ORG_ID]" \
+ -F "file"="@[PATH]"
+
+ {
+ "data": {
+ "id": "ICf76b9de5b229435bb76802427a88464b",
+ "type": "icons",
+ "attributes": {
+ "url": "https://assets.adobedtm.com/icons/17e0df72ece8/ICf76b9de5b229435bb76802427a88464b.png",
+ "status": "pending",
+ "created_at": "2022-02-04T21:14:23.483Z",
+ "updated_at": "2022-02-04T21:14:23.483Z"
+ },
+ "relationships": {
+ "resource": {
+ "links": {
+ "related": "https://reactor.adobe.io/app_surfaces/ASb763e208e4f64c86a4ce6445604355ce"
+ },
+ "data": {
+ "id": "ASb763e208e4f64c86a4ce6445604355ce",
+ "type": "app_surfaces"
+ }
+ }
+ },
+ "links": {
+ "resource": "https://reactor.adobe.io/app_surfaces/ASb763e208e4f64c86a4ce6445604355ce",
+ "self": "https://reactor.adobe.io/icons/ICf76b9de5b229435bb76802427a88464b"
+ }
+ }
+}
+