diff --git a/public/api/v1/openapi.yml b/public/api/v1/openapi.yml index cd6860049..b481cc163 100644 --- a/public/api/v1/openapi.yml +++ b/public/api/v1/openapi.yml @@ -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 @@ -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'. @@ -27,10 +22,8 @@ tags: - name: CX Collections - name: Digital Registry 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: securitySchemes: api_key: diff --git a/spec/swagger_helper.rb b/spec/swagger_helper.rb index cbb73a335..d6b9536b8 100644 --- a/spec/swagger_helper.rb +++ b/spec/swagger_helper.rb @@ -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: [ { @@ -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'. @@ -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: {