epistemik-co/staple-api

Add/revise descriptions on selected schema elements:

Closed this issue · 1 comments

The GraphQL descriptions of all query arguments should be set as in this example:

 X(
    """
    The number of results page to be returned by the query. A page consists of 10 results. If no page argument is provided all matching results are returned. 
    """
    page: Int
    """Filters the selected results based on specified field values"""
    filter: FilterAgent
    """Include indirect instances of this type"""
    inferred: Boolean = false
    """Selected data sources"""
    source: [DataSource]
  ): [X]

Descriptions on the mutation argument source should be set as in this example:

 """Selected data sources"""
    source: [DataSource]

Description of the DataSource enum type should be set to:

"""Available data sources"""
enum DataSource { ... }

Description of the _CONTEXT query (but not the _CONTEXT type!) should be changed to:

type Query {
  """
  Get elements of the _CONTEXT object
  """
  _CONTEXT: _CONTEXT

...
}

done