getMutationKey(...)

The method provides a standardized way to generate MutationKey for Mutations. It could be used to check mutation status.

api.<service>.<operation>.getMutationKey(parameters)

Arguments

1. • parameters: { path, query, header } | void
     • Optional, OpenAPI request parameters for the mutation, strictly-typed ✨
     • parameters will be used to generate the MutationKey

Returns

MutationKey - a mutation key for the operation parameters

Example

With parameters

expect(
  api.entities.postEntitiesIdDocuments.getMutationKey({
    header: {
      'x-monite-version': '1.0.0',
    },
    path: {
      entity_id: '1',
    },
    query: {
      referer: 'https://example.com',
    },
  })
).toEqual([
  {
    url: api.entities.postEntitiesIdDocuments.schema.url,
    method: api.entities.postEntitiesIdDocuments.schema.method,
  },
  {
    header: {
      'x-monite-version': '1.0.0',
    },
    path: {
      entity_id: '1',
    },
    query: {
      referer: 'https://example.com',
    },
  },
]);

Without parameters

expect(
  api.entities.postEntitiesIdDocuments.getMutationKey()
).toEqual([
  {
    url: api.entities.postEntitiesIdDocuments.schema.url,
    method: api.entities.postEntitiesIdDocuments.schema.method,
  },
  {},
]);