# 8 Service APIs

This section provides a reference for APIs that should be implemented by this Building Block. The APIs defined here establish a blueprint for how the Building Block will interact with other Building Blocks. Additional APIs may be implemented by the Building Block, but the listed APIs define a minimal set of functionality that should be provided by any implementation of this Building Block.

The [GovStack non-functional requirements document](https://govstack.gitbook.io/specification/architecture-and-nonfunctional-requirements/6-onboarding) provides additional information on how 'adaptors' may be used to translate an existing API to the patterns described here. This section also provides guidance on how candidate products are tested and how GovStack validates a product's API against the API specifications defined here.

{% hint style="success" %}
All APIs will be defined using the OpenAPI (Swagger) standard. The API definitions will be hosted outside of this document. This section may provide a brief description of required APIs.

This section will primarily contain links to the GitHub repository for OpenAPI definition (yaml) files as well as to a website hosted by GovStack that provides a live API documentation portal.

Note that APIs should be grouped by functional area (from sections 4 and 6) where appropriate.

OpenAPI links to the GitHub repository can be made in an interactive way using the GitBook OpenAPI widget, linking to the GitHub repo version of the .yaml file, remembering to link to the “raw” url. An example from the Registries BB is shown below and can be replaced.
{% endhint %}

## 8.1 Administrative APIs

{% openapi src="/files/GrmK52tMebXLUTKPqh6y" path="/event/new" method="post" %}
[Govstack\_scheduler\_BB\_APIs.json](https://1136010581-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUlnlbFfRJ37dB1aQviRj%2Fuploads%2Fgit-blob-30a508a62188c5d87295e22fcb63ae47402e92ee%2FGovstack_scheduler_BB_APIs.json?alt=media)
{% endopenapi %}

{% openapi src="/files/GrmK52tMebXLUTKPqh6y" path="/event/modifications" method="put" %}
[Govstack\_scheduler\_BB\_APIs.json](https://1136010581-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUlnlbFfRJ37dB1aQviRj%2Fuploads%2Fgit-blob-30a508a62188c5d87295e22fcb63ae47402e92ee%2FGovstack_scheduler_BB_APIs.json?alt=media)
{% endopenapi %}

{% openapi src="/files/GrmK52tMebXLUTKPqh6y" path="/event" method="delete" %}
[Govstack\_scheduler\_BB\_APIs.json](https://1136010581-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUlnlbFfRJ37dB1aQviRj%2Fuploads%2Fgit-blob-30a508a62188c5d87295e22fcb63ae47402e92ee%2FGovstack_scheduler_BB_APIs.json?alt=media)
{% endopenapi %}

## 8.2 User APIs


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://specs.govstack.global/content-management-system/8-service-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.