adobedocs/adobe-assurance-public-apis

adobe-assurance-public-apis's Issues

API Documentation Error

Is there an existing issue for this?

• I have searched the existing issues

Which topic?

https://github.com/AdobeDocs/adobe-assurance-public-apis/blob/main/src/pages/usage/index.md#delete-a-session

What's wrong with the content?

The example given Delete a Session is incomplete.

curl 'https://graffias.adobe.io/graffias/graphql' \
  -H 'Content-Type: application/json' \
  -H 'x-gw-ims-org-id: [Organization ID]@Adobe.Org' \
  -H 'x-api-key: [Client ID]' \
  -H 'Authorization: Bearer [Access Token]' \
  --data-binary '{"query":"mutation deleteSession($uuid: UUID!) { deleteSession(uuid:$uuid)}"}

It doesn't explain where to put the session uuid.

It is missing a closing single comma for the curl example.

What changes do you propose?

Provide examples that have actually been tested.

Anything else that can help to cover this?

Other Issues

• This documentation is very very hard to find.
• It is not referenced on https://developer.adobe.com/adobe-assurance-public-apis/ which seems to be the main page for this API.
• The main page suggests using authentication methods which Adobe is now deprecating.
• A lot of the documentation in this repo is boiler plate and not relevant to using the API. Eg, all the yarn instructions are not required.
• This is the first Adobe API that I've seen that uses GraphQL. This documentation could make that fact clearer, and be a bit more helpful to developers by providing some explanation of the advantages, and how to invoke and debug the API.
• This API is missing documentation for how to send events into Adobe Assurance.