Back to Apievangelist

Governance

api-governance.md

latest2.8 KB
Original Source

API Evangelist Network API

API Evangelist Network API

Governance

The policies and rules that align the business and engineering sides of API operations.


Policies

GET https://api.apievangelist.com/v1

/policies

Search or browse the policies collection (283) — API policies for enterprise operations.

Policies › query Parameters

q ​string

Free-text query over title, summary, tags, and body.

tags ​string

Comma-separated tag slugs.

match ​string · enum

Tag match mode.

Enum values: any

all

Default: any

fields ​string

Comma-separated sparse field projection.

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

Policies › Responses

200

Paged policies.

PagedEnvelope

meta ​object

dataDoc[]


Policy

GET https://api.apievangelist.com/v1

/policies/{slug}

One entry from the policies collection; include=content adds the full body.

Policy › path Parameters

slug ​string · required

Policy › query Parameters

include ​string · enum

Set to content to inline the full markdown body (up to 200 KB).

Enum values: content

Policy › Responses

200404

The entry.

Doc

type ​string

slug ​string

title ​string

summary ​string

url ​string · uri

tags ​string[]

date ​string

content ​string

Full markdown body when include=content.


Rules

GET https://api.apievangelist.com/v1

/rules

Search or browse the rules collection (617) — machine-readable API governance rules.

Rules › query Parameters

q ​string

Free-text query over title, summary, tags, and body.

tags ​string

Comma-separated tag slugs.

match ​string · enum

Tag match mode.

Enum values: any

all

Default: any

fields ​string

Comma-separated sparse field projection.

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

Rules › Responses

200

Paged rules.

PagedEnvelope

meta ​object

dataDoc[]


Rule

GET https://api.apievangelist.com/v1

/rules/{slug}

One entry from the rules collection; include=content adds the full body.

Rule › path Parameters

slug ​string · required

Rule › query Parameters

include ​string · enum

Set to content to inline the full markdown body (up to 200 KB).

Enum values: content

Rule › Responses

200404

The entry.

Doc

type ​string

slug ​string

title ​string

summary ​string

url ​string · uri

tags ​string[]

date ​string

content ​string

Full markdown body when include=content.


GuidanceToolbox