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/icon/create.md b/api/reference/1.0/app_configurations/relationships/icon/create.md new file mode 100644 index 0000000..bbebef9 --- /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 %} + +
+ +
+ +
+ + + + + +
diff --git a/api/reference/1.0/app_configurations/relationships/icon/fetch_related.md b/api/reference/1.0/app_configurations/relationships/icon/fetch_related.md new file mode 100644 index 0000000..0c29301 --- /dev/null +++ b/api/reference/1.0/app_configurations/relationships/icon/fetch_related.md @@ -0,0 +1,13 @@ +--- +title: Fetch related +labels: + - unstable +--- + +# Fetch the related Icon + +{% labels %} + +Retrieve the AppConfiguration's Icon + +{% scenario app_configuration_relationship_icon.show icons.get_the_icon_for_an_app_configuration %} diff --git a/api/reference/1.0/app_surfaces/list.md b/api/reference/1.0/app_surfaces/list.md index 3050c2c..903a135 100644 --- a/api/reference/1.0/app_surfaces/list.md +++ b/api/reference/1.0/app_surfaces/list.md @@ -8,6 +8,6 @@ labels: {% labels %} -Retrieve the App Surfaces owned by the specified Company. +Retrieve the App Surfaces owned by the specified Company. Icons can be included with a query parameter `?include=icon` {% scenario app_surfaces.index %} diff --git a/api/reference/1.0/app_surfaces/relationships/icon/create.md b/api/reference/1.0/app_surfaces/relationships/icon/create.md new file mode 100644 index 0000000..d9316a5 --- /dev/null +++ b/api/reference/1.0/app_surfaces/relationships/icon/create.md @@ -0,0 +1,147 @@ +--- +title: Create +labels: + - unstable +--- + +# Create an Icon for an AppSurface + +{% 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 %} + +
+ +
+ +
+ + + + + +
diff --git a/api/reference/1.0/app_surfaces/relationships/icon/fetch_related.md b/api/reference/1.0/app_surfaces/relationships/icon/fetch_related.md new file mode 100644 index 0000000..e712b32 --- /dev/null +++ b/api/reference/1.0/app_surfaces/relationships/icon/fetch_related.md @@ -0,0 +1,13 @@ +--- +title: Fetch related +labels: + - unstable +--- + +# Fetch the related Icon + +{% labels %} + +Retrieve the AppSurface's Icon + +{% scenario app_surface_relationship_icon.show icons.get_the_icon_for_an_app_surface %} diff --git a/api/reference/1.0/icons/create/app_configuration.md b/api/reference/1.0/icons/create/app_configuration.md deleted file mode 100644 index 111bf99..0000000 --- a/api/reference/1.0/icons/create/app_configuration.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Create on AppConfiguration -labels: - - unstable ---- - -# Create an Icon on a AppConfiguration - -{% labels %} - -{% alert info, Note %} -This endpoint expects multipart requests. -{% endalert %} - -
- -
- -{% scenario app_configuration_relationship_icon.show %} diff --git a/api/reference/1.0/icons/create/app_surface.md b/api/reference/1.0/icons/create/app_surface.md deleted file mode 100644 index c921ea3..0000000 --- a/api/reference/1.0/icons/create/app_surface.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Create on AppSurface -labels: - - unstable ---- - -# Create an Icon on a AppSurface - -{% labels %} - -{% alert info, Note %} -This endpoint expects multipart requests. -{% endalert %} - -
- -
- -{% scenario app_surface_relationship_icon.show %} diff --git a/api/reference/1.0/icons/delete.md b/api/reference/1.0/icons/delete.md new file mode 100644 index 0000000..31c2e80 --- /dev/null +++ b/api/reference/1.0/icons/delete.md @@ -0,0 +1,11 @@ +--- +title: Delete +labels: + - unstable +--- + +# Delete an Icon + +{% labels %} + +{% scenario icons.delete icons.delete_an_icon %} diff --git a/api/reference/1.0/icons/fetch.md b/api/reference/1.0/icons/fetch.md index 35590c3..c039a99 100644 --- a/api/reference/1.0/icons/fetch.md +++ b/api/reference/1.0/icons/fetch.md @@ -8,6 +8,6 @@ labels: {% labels %} -Retrieve a specific Icon, based on its ID. +Retrieve the data for an existing Icon, based on its ID. {% scenario icons.show %} diff --git a/api/reference/1.0/icons/index.md b/api/reference/1.0/icons/index.md index 3bece65..6a1591f 100644 --- a/api/reference/1.0/icons/index.md +++ b/api/reference/1.0/icons/index.md @@ -8,6 +8,6 @@ labels: {% labels %} -`Icons` are images you can add to Launch resources of these types: -- `AppSurfaces` -- `AppConfigurations` +**The implementation of `Icons` are in flux as features are added, removed, and reworked.** + +`Icons` allow images to be added to select resources, currently AppConfigurations and AppSurfaces. diff --git a/api/reference/1.0/icons/update.md b/api/reference/1.0/icons/update.md new file mode 100644 index 0000000..2ce9d65 --- /dev/null +++ b/api/reference/1.0/icons/update.md @@ -0,0 +1,141 @@ +--- +title: Update +labels: + - unstable +--- + +# Update an Icon + +{% labels %} + +
+ +
+ +
+ + + + + +