Skip to content

Minor changes to openapi.yaml spec #2091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sanason merged 2 commits into from
Jul 10, 2026
Merged

Minor changes to openapi.yaml spec #2091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cd47a1
Minor changes to openapi.yaml spec
sanason Jul 10, 2026
d9da108
Remove localhost description
sanason Jul 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 5 additions & 12 deletions public/api/v1/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
---
openapi: 3.0.1
info:
title: Touchpoints API
description: |-
Touchpoints makes customer feedback easier for federal agencies,
and the Touchpoints API provides a convenient, programmatic way to access the data for your forms, responses, and other Customer Experience (CX) related domain objects.
title: Touchpoints API Reference
description: For an introduction to the Touchpoints API, see the [API Overview](https://touchpoints.digital.gov/api-overview)
page.
version: v1
contact:
name: Touchpoints Support
url: https://touchpoints.digital.gov/
email: feedback-analytics@gsa.gov
tags:
- name: Forms
description: |2
Expand All @@ -18,7 +13,7 @@ tags:
create a form, publish it in one of several digital formats and view form responses submitted by your users. You can also share
your form with other Touchpoints users so that it may be managed collectively by your team.

Use the following endpoints to view your forms and form responses. Normal users can see forms for which they are a Form Manager or Response Viewer. Users with the Organization Admin role can see all forms belonging to their organization.
Use the following endpoints to view your forms and form responses. Standard users can see forms for which they are a Form Manager or Response Viewer. Users with the Organization Admin role can see all forms belonging to their organization.

Forms are identified by their short UUID, which is the 8-character string of letters and numbers used in Touchpoints form URLs. For instance, if your form lives at https://touchpoints.app.cloud.gov/admin/forms/8fc3c208, its short UUID is '8fc3c208'.

Expand All @@ -27,10 +22,8 @@ tags:
- name: CX Collections
- name: Digital Registry
servers:

@sanason sanason Jul 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: This file was produced by running the rswag generator and then manually deleting the localhost entry from servers. I don't want localhost listed as the first/default server in our official API documentation but I haven't found a way yet to get the RSwag tests to pass without listing localhost first in swagger_helper.rb. Obviously, it's bad to edit auto-generated files. I will automate this step someday.

- url: http://localhost:3000/api/v1
description: Local development server
- url: https://api.gsa.gov/analytics/touchpoints/v1
description: The API gateway that hosts the production Touchpoints API
description: The production Touchpoints API
components:
securitySchemes:
api_key:
Expand Down
15 changes: 4 additions & 11 deletions spec/swagger_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,9 @@
'v1/openapi.yml' => {
openapi: '3.0.1',
info: {
title: 'Touchpoints API',
description: 'Touchpoints makes customer feedback easier for federal agencies,
and the Touchpoints API provides a convenient, programmatic way to access the data for your forms, responses, and other Customer Experience (CX) related domain objects.',
title: 'Touchpoints API Reference',
description: 'For an introduction to the Touchpoints API, see the [API Overview](https://touchpoints.digital.gov/api-overview) page.',
version: 'v1',
contact: {
name: 'Touchpoints Support',
url: 'https://touchpoints.digital.gov/',
email: 'feedback-analytics@gsa.gov',
}
},
tags: [
{
Expand All @@ -34,7 +28,7 @@
create a form, publish it in one of several digital formats and view form responses submitted by your users. You can also share
your form with other Touchpoints users so that it may be managed collectively by your team.

Use the following endpoints to view your forms and form responses. Normal users can see forms for which they are a Form Manager or Response Viewer. Users with the Organization Admin role can see all forms belonging to their organization.
Use the following endpoints to view your forms and form responses. Standard users can see forms for which they are a Form Manager or Response Viewer. Users with the Organization Admin role can see all forms belonging to their organization.

Forms are identified by their short UUID, which is the 8-character string of letters and numbers used in Touchpoints form URLs. For instance, if your form lives at https://touchpoints.app.cloud.gov/admin/forms/8fc3c208, its short UUID is '8fc3c208'.

Expand All @@ -54,11 +48,10 @@
servers: [
{
url: 'http://localhost:3000/api/v1',
description: 'Local development server',
},
{
url: 'https://api.gsa.gov/analytics/touchpoints/v1',
description: 'The API gateway that hosts the production Touchpoints API',
description: 'The production Touchpoints API',
},
],
components: {
Expand Down