rest.ini [ApiProvider] #

The block [ApiProvider] of settings/rest.ini, with 1 setting(s).

Never edit settings/rest.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/rest.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/rest.ini.append.php for one siteaccess,
• extension/<extension>/settings/rest.ini.append.php in an extension (read when the extension is active).

ProviderClass #

Context help of help maintained as content for clients with a token (an OAuth token or a personal API key with
the scope help): /api/help/v1/topic/<help_id>, /api/help/v1/manual/<remote_id> (doc/eng-us/features/6.0/help-content.md)
The GraphQL API, /api/graphql (settings/graphql.ini, off until enabled; doc/eng-us/features/6.0/graphql.md)
The migrations, read only, for users with migration/read (an OAuth token or a personal API key with the scope
migration:read): /api/migration/v1/status, /api/migration/v1/runs, /api/migration/v1/runs/<run id>,
/api/migration/v1/snapshot

Default: a hash of 4: auth=ezpRestAuthProvider, help=expHelpRestProvider, graphql=expGraphQLRestProvider, migration=expMigrationRestProvider.

<?php /* #?ini charset="utf-8"?
# settings/override/rest.ini.append.php
[ApiProvider]
# an empty "ProviderClass[]" first replaces the shipped list; without it the items are added
ProviderClass[]
ProviderClass[auth]=ezpRestAuthProvider
ProviderClass[help]=expHelpRestProvider
ProviderClass[graphql]=expGraphQLRestProvider
ProviderClass[migration]=expMigrationRestProvider
*/ ?>

Related #

• All blocks of rest.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/rest.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.