Investigate Developer Portal for API documentation

[aburkleaux-amazon]

Is your feature request related to a problem? Please describe.

I would want to deploy this solution as a micro-service, then Media Supply chain / MAM developers could integrate MIE to their workflow manager. But without API documentation, it’s hard.

Context: Many developers will use MIE : translation workflow for the production team, video segment workflow for the distribution team, metadatas generation workflows for the MAM team, video moderation and classification for QC team.

Describe the feature you'd like Could it be possible to have API Documentation with an API Portal. For example : https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-developer-portal.html

Additional context Add any other context or screenshots about the feature request here.

[gmarchand]

Could it be possible to have the same level of documentation as the AWS documentation. For example : https://docs.aws.amazon.com/rekognition/latest/dg/API_CompareFaces.html I have the description/role, Request Syntax, Request Parameters, Response Elements and the list of Errors

[gmarchand]

There are several API resources using media objects : /create /workflow/execution Could it be possible to define what it is, and how to use this object

"Input": 
    {"Media":
        {"Video":
            {
                "S3Bucket": "xxxataplane-1i4atzj0dxl7y",
                "S3Key":"xxx.mp4"
            }
        }
    },

{
    "AssetId": "98d25553-29ff-424b-b5ab-8faca3ddbce9",
    "S3Bucket": "vodsub-miestack-xxx-dataplane-1i4atzj0dxl7y",
    "S3Key": "private/assets/98d25553-29ff-424b-b5ab-8faca3ddbce9/input/xxx_proxy.mp4"
}

[aburkleaux-amazon]

We need the Swagger or Open API spec to make this possible. I believe this is generated internally by Chalice and embedded in the serverless deployment scripts for APIs. It may be possible to extract this in our build process.